rbs 3.0.4 → 3.1.1

data/lib/rbs/subtractor.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module RBS
+  class Subtractor
+    def initialize(minuend, subtrahend)
+      @minuend = minuend
+      @subtrahend = subtrahend
+    end
+
+    def call(minuend = @minuend, context: nil)
+      minuend.map do |decl|
+        case decl
+        when AST::Declarations::Constant
+          name = absolute_typename(decl.name, context: context)
+          decl unless @subtrahend.constant_name?(name)
+        when AST::Declarations::Interface
+          name = absolute_typename(decl.name, context: context)
+          decl unless @subtrahend.interface_name?(name)
+        when AST::Declarations::Class, AST::Declarations::Module
+          name = absolute_typename(decl.name, context: context)
+          case
+          when @subtrahend.class_decl?(name) && decl.is_a?(AST::Declarations::Class)
+            filter_members(decl, context: context)
+          when @subtrahend.module_decl?(name) && decl.is_a?(AST::Declarations::Module)
+            filter_members(decl, context: context)
+          when @subtrahend.constant_name?(name)
+            nil
+          else
+            decl
+          end
+        when AST::Declarations::Global
+          decl unless @subtrahend.global_decls[decl.name]
+        when AST::Declarations::TypeAlias
+          name = absolute_typename(decl.name, context: context)
+          decl unless @subtrahend.type_alias_decls[name]
+        when AST::Declarations::ClassAlias
+          name = absolute_typename(decl.new_name, context: context)
+          decl unless @subtrahend.class_alias?(name) || @subtrahend.class_decl?(name)
+        when AST::Declarations::ModuleAlias
+          name = absolute_typename(decl.new_name, context: context)
+          decl unless @subtrahend.module_alias?(name) || @subtrahend.module_decl?(name)
+        else
+          raise "unknwon decl: #{(_ = decl).class}"
+        end
+      end.compact
+    end
+
+    private def filter_members(decl, context:)
+      owner = absolute_typename(decl.name, context: context)
+
+      context = _ = [context, decl.name]
+      children = call(decl.each_decl.to_a, context: context) +
+        decl.each_member.reject { |m| member_exist?(owner, m, context: context) }
+      return nil if children.empty?
+
+      update_decl(decl, members: children)
+    end
+
+    private def member_exist?(owner, member, context:)
+      case member
+      when AST::Members::MethodDefinition
+        method_exist?(owner, member.name, member.kind)
+      when AST::Members::Alias
+        method_exist?(owner, member.new_name, member.kind)
+      when AST::Members::AttrReader
+        method_exist?(owner, member.name, member.kind)
+      when AST::Members::AttrWriter
+        method_exist?(owner, :"#{member.name}=", member.kind)
+      when AST::Members::AttrAccessor
+        # TODO: It unexpectedly removes attr_accessor even if either reader or writer does not exist in the subtrahend.
+        method_exist?(owner, member.name, member.kind) || method_exist?(owner, :"#{member.name}=", member.kind)
+      when AST::Members::InstanceVariable
+        ivar_exist?(owner, member.name, :instance)
+      when AST::Members::ClassInstanceVariable
+        ivar_exist?(owner, member.name, :singleton)
+      when AST::Members::ClassVariable
+        cvar_exist?(owner, member.name)
+      when AST::Members::Include, AST::Members::Extend, AST::Members::Prepend
+        mixin_exist?(owner, member, context: context)
+      when AST::Members::Public, AST::Members::Private
+        # They should not be removed even if the subtrahend has them.
+        false
+      else
+        raise "unknown member: #{(_ = member).class}"
+      end
+    end
+
+    private def method_exist?(owner, method_name, kind)
+      each_member(owner).any? do |m|
+        case m
+        when AST::Members::MethodDefinition
+          m.name == method_name && m.kind == kind
+        when AST::Members::Alias
+          m.new_name == method_name && m.kind == kind
+        when AST::Members::AttrReader
+          m.name == method_name && m.kind == kind
+        when AST::Members::AttrWriter
+          :"#{m.name}=" == method_name && m.kind == kind
+        when AST::Members::AttrAccessor
+          (m.name == method_name || :"#{m.name}=" == method_name) && m.kind == kind
+        end
+      end
+    end
+
+    private def ivar_exist?(owner, name, kind)
+      each_member(owner).any? do |m|
+        case m
+        when AST::Members::InstanceVariable
+          m.name == name
+        when AST::Members::Attribute
+          ivar_name = m.ivar_name == false ? nil : m.ivar_name || :"@#{m.name}"
+          ivar_name == name && m.kind == kind
+        end
+      end
+    end
+
+    private def cvar_exist?(owner, name)
+      each_member(owner).any? do |m|
+        case m
+        when AST::Members::ClassVariable
+          m.name == name
+        end
+      end
+    end
+
+    private def each_member(owner, &block)
+      return enum_for((__method__ or raise), owner) unless block
+
+      entry = @subtrahend.class_decls[owner]
+      return unless entry
+      decls = entry.decls.map { |d| d.decl }
+
+      decls.each { |d| d.members.each { |m| block.call(m) } }
+    end
+
+    private def mixin_exist?(owner, mixin, context:)
+      candidates = typename_candidates(mixin.name, context: context)
+      each_member(owner).any? do |m|
+        case m
+        when mixin.class
+          # @type var m: AST::Members::Include | AST::Members::Extend | AST::Members::Prepend
+          candidates.include?(m.name)
+        end
+      end
+    end
+
+    private def update_decl(decl, members:)
+      case decl
+      when AST::Declarations::Class
+        decl.class.new(name: decl.name, type_params: decl.type_params, super_class: decl.super_class,
+                        annotations: decl.annotations, location: decl.location, comment: decl.comment,
+                        members: members)
+      when AST::Declarations::Module
+        decl.class.new(name: decl.name, type_params: decl.type_params, self_types: decl.self_types,
+                        annotations: decl.annotations, location: decl.location, comment: decl.comment,
+                        members: members)
+      end
+    end
+
+    private def absolute_typename(name, context:)
+      while context
+        ns = context[1] or raise
+        name = name.with_prefix(ns.to_namespace)
+        context = _ = context[0]
+      end
+      name.absolute!
+    end
+
+    private def typename_candidates(name, context:)
+      ret = [name.absolute!, name.relative!]
+      return ret if name.absolute?
+
+      while context
+        ns = context[1] or raise
+        name = name.with_prefix(ns.to_namespace)
+        ret.concat [name.absolute!, name.relative!]
+
+        context = _ = context[0]
+      end
+
+      ret
+    end
+  end
+end

data/lib/rbs/vendorer.rb

@@ -31,7 +31,7 @@ module RBS
 
       if core_root = loader.core_root
         RBS.logger.info "Vendoring core RBSs in #{vendor_dir + "core"}..."
-        loader.each_file(core_root, immediate: false, skip_hidden: true) do |file_path|
+        FileFinder.each_file(core_root, immediate: false, skip_hidden: true) do |file_path|
           paths << [file_path, Pathname("core") + file_path.relative_path_from(core_root)]
         end
       end
@@ -43,7 +43,7 @@ module RBS
 
           RBS.logger.info "Vendoring #{lib.name}(#{spec.version}) RBSs in #{vendor_dir + dest_dir}..."
 
-          loader.each_file(path, skip_hidden: true, immediate: false) do |file_path|
+          FileFinder.each_file(path, skip_hidden: true, immediate: false) do |file_path|
             paths << [file_path, dest_dir + file_path.relative_path_from(path)]
           end
 
@@ -52,7 +52,7 @@ module RBS
 
           RBS.logger.info "Vendoring #{lib.name}(#{path.version}) RBSs in #{vendor_dir + dest_dir}..."
 
-          loader.each_file(path.path, skip_hidden: true, immediate: false) do |file_path|
+          FileFinder.each_file(path.path, skip_hidden: true, immediate: false) do |file_path|
             paths << [file_path, dest_dir + file_path.relative_path_from(path.path)]
           end
         else

data/lib/rbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBS
-  VERSION = "3.0.4"
+  VERSION = "3.1.1"
 end

data/lib/rbs/writer.rb

@@ -167,6 +167,18 @@ module RBS
           puts "type #{name_and_params(decl.name, decl.type_params)} = #{decl.type}"
         }
 
+      when AST::Declarations::ClassAlias
+        write_comment decl.comment
+        write_loc_source(decl) {
+          puts "class #{decl.new_name} = #{decl.old_name}"
+        }
+
+      when AST::Declarations::ModuleAlias
+        write_comment decl.comment
+        write_loc_source(decl) {
+          puts "module #{decl.new_name} = #{decl.old_name}"
+        }
+
       when AST::Declarations::Interface
         write_comment decl.comment
         write_annotation decl.annotations

data/lib/rbs.rb

@@ -16,6 +16,7 @@ require "rbs/namespace"
 require "rbs/type_name"
 require "rbs/types"
 require "rbs/method_type"
+require "rbs/file_finder"
 require "rbs/ast/type_param"
 require "rbs/ast/directives"
 require "rbs/ast/declarations"
@@ -46,6 +47,7 @@ require "rbs/vendorer"
 require "rbs/validator"
 require "rbs/factory"
 require "rbs/repository"
+require "rbs/subtractor"
 require "rbs/ancestor_graph"
 require "rbs/locator"
 require "rbs/type_alias_dependency"

data/lib/rdoc/discover.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 begin
-  gem 'rdoc', '~> 6.4.0'
+  gem 'rdoc', '~> 6.4'
   require 'rdoc_plugin/parser'
   module RDoc
     class Parser

data/sig/cli.rbs

@@ -76,6 +76,8 @@ module RBS
 
     def run_annotate: (Array[String], top) -> void
 
+    def run_subtract: (Array[String], top) -> void
+
     def test_opt: (LibraryOptions) -> String?
 
     def collection_options: (Array[String]) -> OptionParser

data/sig/collection/config/lockfile_generator.rbs

@@ -36,7 +36,9 @@ module RBS
 
         # Inserts a entry to lockfile of a gem and its dependencies, if not included in `ignored_gems:`
         #
-        def assign_gem: (name: String, version: String?, src_data: Sources::source_entry?, ignored_gems: Set[String]) -> void
+        # * If `skip:` is true, it skips adding the gem, but adds it's dependencies.
+        #
+        def assign_gem: (name: String, version: String?, src_data: Sources::source_entry?, ignored_gems: Set[String], ?skip: bool) -> void
 
         def assign_stdlib: (name: String, from_gem: String?) -> void
 

data/sig/environment_loader.rbs

@@ -3,23 +3,25 @@ module RBS
   #
   # Set up your configuration through repository and `#add` method.
   #
-  #   # Set up the repository to load library RBSs from.
-  #   repo = RBS::Repository.default
-  #   repo.add(Pathname("vendor/rbs/gem-rbs"))
-  #   repo.add(Pathname("vendor/rbs/internal-rbs"))
+  # ```ruby
+  # # Set up the repository to load library RBSs from.
+  # repo = RBS::Repository.default
+  # repo.add(Pathname("vendor/rbs/gem-rbs"))
+  # repo.add(Pathname("vendor/rbs/internal-rbs"))
   #
-  #   loader = RBS::EnvironmentLoader.new(repository: repo)
+  # loader = RBS::EnvironmentLoader.new(repository: repo)
   #
-  #   # Add libraries to load RBS files.
-  #   loader.add(library: "minitest")
-  #   loader.add(library: "rbs", version: "1.0.0")
+  # # Add libraries to load RBS files.
+  # loader.add(library: "minitest")
+  # loader.add(library: "rbs", version: "1.0.0")
   #
-  #   # Add dirs to load RBS files from.
-  #   loader.add(path: Pathname("sig"))
+  # # Add dirs to load RBS files from.
+  # loader.add(path: Pathname("sig"))
   #
-  #   # Load RBSs into an environment.
-  #   environment = RBS::Environment.new()
-  #   loader.load(env: environment)
+  # # Load RBSs into an environment.
+  # environment = RBS::Environment.new()
+  # loader.load(env: environment)
+  # ```
   #
   class EnvironmentLoader
     class UnknownLibraryError < StandardError
@@ -35,6 +37,8 @@ module RBS
       def initialize: (name: String, version: String?) -> void
     end
 
+    include FileFinder
+
     DEFAULT_CORE_ROOT: Pathname
 
     attr_reader core_root: Pathname?
@@ -103,7 +107,5 @@ module RBS
     def each_signature: () { (source, Pathname, Buffer, Array[AST::Declarations::t], Array[AST::Directives::t]) -> void } -> void
 
     def each_dir: { (source, Pathname) -> void } -> void
-
-    def each_file: (Pathname path, immediate: boolish, skip_hidden: boolish) { (Pathname) -> void } -> void
   end
 end

data/sig/file_finder.rbs

@@ -0,0 +1,6 @@
+module RBS
+  module FileFinder
+    def self?.each_file: (Pathname path, immediate: boolish, skip_hidden: boolish) { (Pathname) -> void } -> void
+                        | (Pathname path, immediate: boolish, skip_hidden: boolish) -> Enumerator[Pathname, void]
+  end
+end

data/sig/manifest.yaml

@@ -5,3 +5,4 @@ dependencies:
   - name: optparse
   - name: tsort
   - name: rdoc
+  - name: abbrev

data/sig/parser.rbs

@@ -2,8 +2,7 @@ module RBS
   class Parser
     # Parse a method type and return it
     #
-    # When `pos` keyword is specified, skips the first `pos` characters from the input.
-    # If no token is left in the input, it returns `nil`.
+    # When `range` keyword is specified, it starts parsing from the `begin` to the `endo` the range.
     #
     # ```ruby
     # RBS::Parser.parse_method_type("() -> void")                                # => `() -> void`
@@ -12,12 +11,21 @@ module RBS
     # RBS::Parser.parse_method_type("() -> void () -> String", range: 23...)     # => nil
     # ```
     #
-    def self.parse_method_type: (Buffer | String, ?range: Range[Integer?], ?variables: Array[Symbol]) -> MethodType?
+    # When `require_eof` is `true`, an error is raised if more tokens are left in the input.
+    # (Defaults to `false`.)
+    #
+    # ```ruby
+    # RBS::Parser.parse_method_type("() -> void () -> String", require_eof: false)    # => `() -> void`
+    # RBS::Parser.parse_method_type("() -> void () -> String", require_eof: true)     # => Raises an error
+    #
+    # RBS::Parser.parse_method_type("", require_eof: true)                            # => nil
+    # ```
+    #
+    def self.parse_method_type: (Buffer | String, ?range: Range[Integer?], ?variables: Array[Symbol], ?require_eof: bool) -> MethodType?
 
     # Parse a type and return it
     #
-    # When `pos` keyword is specified, skips the first `pos` characters from the input.
-    # If no token is left in the input, it returns `nil`.
+    # When `range` keyword is specified, it starts parsing from the `begin` to the `endo` the range.
     #
     # ```ruby
     # RBS::Parser.parse_type("String")                          # => `String`
@@ -26,7 +34,17 @@ module RBS
     # RBS::Parser.parse_type("String Integer", pos: 14...)      # => nil
     # ```
     #
-    def self.parse_type: (Buffer | String, ?range: Range[Integer?], ?variables: Array[Symbol]) -> Types::t?
+    # When `require_eof` is `true`, an error is raised if more tokens are left in the input.
+    # (Defaults to `false`.)
+    #
+    # ```ruby
+    # RBS::Parser.parse_type("String untyped", require_eof: false)    # => `String`
+    # RBS::Parser.parse_type("String untyped", require_eof: true)     # => Raises an error
+    #
+    # RBS::Parser.parse_type("", require_eof: true)                   # => nil
+    # ```
+    #
+    def self.parse_type: (Buffer | String, ?range: Range[Integer?], ?variables: Array[Symbol], ?require_eof: bool) -> Types::t?
 
     # Parse whole RBS file and return an array of declarations
     #
@@ -38,9 +56,9 @@ module RBS
 
     def self.buffer: (String | Buffer source) -> Buffer
 
-    def self._parse_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables) -> Types::t?
+    def self._parse_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables, bool require_eof) -> Types::t?
 
-    def self._parse_method_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables) -> MethodType?
+    def self._parse_method_type: (Buffer, Integer start_pos, Integer end_pos, Array[Symbol] variables, bool require_eof) -> MethodType?
 
     def self._parse_signature: (Buffer, Integer end_pos) -> [Array[AST::Directives::t], Array[AST::Declarations::t]]
 

data/sig/repository.rbs

@@ -3,12 +3,14 @@ module RBS
   #
   # A repository object can handle multiple repository roots.
   #
-  #   repo = RBS::Repository.new()
-  #   repo.add(Pathname("vendor/rbs/gem-rbs"))
-  #   repo.add(Pathname("vendor/rbs/internal-rbs"))
-  #   repo.add(Pathname("vendor/rbs/definitely-rbs"))
+  # ```ruby
+  # repo = RBS::Repository.new()
+  # repo.add(Pathname("vendor/rbs/gem-rbs"))
+  # repo.add(Pathname("vendor/rbs/internal-rbs"))
+  # repo.add(Pathname("vendor/rbs/definitely-rbs"))
   #
-  #   repo.lookup("minitest", "2.1.3") => Pathname or nil
+  # repo.lookup("minitest", "2.1.3") # => Pathname or nil
+  # ```
   #
   # If one gem version can resolve to several directories, the last added dir wins.
   #

data/sig/shims/bundler.rbs

@@ -15,6 +15,8 @@ module Bundler
 
   class Dependency < Gem::Dependency
     attr_reader autorequire: Array[String]?
+
+    attr_reader source: untyped
   end
 
   class Definition

data/sig/shims/rubygems.rbs

@@ -12,4 +12,8 @@ module Gem
   class Dependency
     def name: () -> String
   end
+
+  module ::Kernel
+    def self?.gem: (String, *String) -> void
+  end
 end

data/sig/subtractor.rbs

@@ -0,0 +1,33 @@
+module RBS
+  class Subtractor
+    type decl_with_members = AST::Declarations::Class | AST::Declarations::Module
+
+    @minuend: Array[AST::Declarations::t]
+    @subtrahend: Environment
+
+    def initialize: (Array[AST::Declarations::t] minuend, Environment subtrahend) -> void
+
+    def call: (?Array[AST::Declarations::t], ?context: Resolver::context) -> Array[AST::Declarations::t]
+
+    private def filter_members: (decl_with_members, context: Resolver::context) -> decl_with_members?
+
+    private def member_exist?: (TypeName owner, AST::Members::t, context: Resolver::context) -> boolish
+
+    private def method_exist?: (TypeName owner, Symbol method_name, AST::Members::MethodDefinition::kind) -> boolish
+
+    private def ivar_exist?: (TypeName owner, Symbol ivar_name, AST::Members::Attribute::kind) -> boolish
+
+    private def cvar_exist?: (TypeName owner, Symbol cvar_name) -> boolish
+
+    private def each_member: (TypeName owner) { (AST::Members::t | AST::Declarations::t) -> void } -> void
+                           | (TypeName owner) -> Enumerator[(AST::Members::t | AST::Declarations::t), void]
+
+    private def mixin_exist?: (TypeName owner, AST::Members::Include | AST::Members::Extend | AST::Members::Prepend, context: Resolver::context) -> boolish
+
+    private def update_decl: (decl_with_members, members: Array[AST::Declarations::t | AST::Members::t]) -> decl_with_members
+
+    private def absolute_typename: (TypeName, context: Resolver::context) -> TypeName
+
+    private def typename_candidates: (TypeName, context: Resolver::context) -> Array[TypeName]
+  end
+end

data/sig/types.rbs

@@ -18,9 +18,11 @@ module RBS
       # Yields all direct sub types included in the type.
       # It doesn't yield the type itself.
       #
-      #   parse("Hash[String, Array[Symbol]]").each_type do |ty|
-      #     ...       # Yields String and Array[Symbol]
-      #   end
+      # ```ruby
+      # parse("Hash[String, Array[Symbol]]").each_type do |ty|
+      #   ...       # Yields String and Array[Symbol]
+      # end
+      # ```
       #
       def each_type: () { (t) -> void } -> void
                    | () -> Enumerator[t, void]
@@ -32,9 +34,11 @@ module RBS
       # Returns a String representation.
       # `level` is used internally.
       #
-      #   parse("String").to_s               # => "String"
-      #   parse("String | Integer").to_s()   # => "String | Integer"
-      #   parse("String | Integer").to_s(1)  # => "(String | Integer)"
+      # ```ruby
+      # parse("String").to_s               # => "String"
+      # parse("String | Integer").to_s()   # => "String | Integer"
+      # parse("String | Integer").to_s(1)  # => "(String | Integer)"
+      # ```
       #
       def to_s: (?Integer level) -> String
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.1
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies: []
 description: RBS is the language for type signatures for Ruby and standard library
   definitions.
@@ -182,6 +182,7 @@ files:
 - lib/rbs/environment_walker.rb
 - lib/rbs/errors.rb
 - lib/rbs/factory.rb
+- lib/rbs/file_finder.rb
 - lib/rbs/location_aux.rb
 - lib/rbs/locator.rb
 - lib/rbs/method_type.rb
@@ -201,6 +202,7 @@ files:
 - lib/rbs/resolver/type_name_resolver.rb
 - lib/rbs/sorter.rb
 - lib/rbs/substitution.rb
+- lib/rbs/subtractor.rb
 - lib/rbs/test.rb
 - lib/rbs/test/errors.rb
 - lib/rbs/test/hook.rb
@@ -259,6 +261,7 @@ files:
 - sig/environment_walker.rbs
 - sig/errors.rbs
 - sig/factory.rbs
+- sig/file_finder.rbs
 - sig/location.rbs
 - sig/locator.rbs
 - sig/manifest.yaml
@@ -284,6 +287,7 @@ files:
 - sig/shims/rubygems.rbs
 - sig/sorter.rbs
 - sig/substitution.rbs
+- sig/subtractor.rbs
 - sig/type_alias_dependency.rbs
 - sig/type_alias_regularity.rbs
 - sig/type_param.rbs
@@ -447,7 +451,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Type signature for Ruby.