rbs 3.2.2 → 3.3.0.pre.1

data/lib/rbs/sorter.rb

@@ -28,140 +28,167 @@ module RBS
       end
     end
 
-    def group(member)
-      case member
-      when Declarations::TypeAlias
-        -3
-      when Declarations::Constant
-        -2
-      when Declarations::Class, Declarations::Module, Declarations::Interface
-        -1
-      when Members::Include
-        0.0
-      when Members::Prepend
-        0.2
-      when Members::Extend
-        0.4
-      when Members::ClassVariable
-        1
-      when Members::ClassInstanceVariable
-        2
-      when Members::InstanceVariable
-        3
-      when Members::AttrAccessor, Members::AttrWriter, Members::AttrReader
-        if member.kind == :singleton
-          5.0
-        else
-          6.0
-        end
-      when Members::MethodDefinition
-        case member.kind
-        when :singleton_instance
-          4
-        when :singleton
-          if member.name == :new
-            5.2
-          elsif member.visibility == :public
-            5.4
-          else
-            5.6
-          end
-        else
-          if member.name == :initialize
-            6.2
-          elsif member.visibility == :public
-            6.4
-          else
-            6.6
-          end
-        end
-      when Members::Alias
-        if member.singleton?
-          5.4
-        else
-          6.4
-        end
-      else
-        raise
-      end
-    end
-
-    def key(member)
-      case member
-      when Members::Include, Members::Extend, Members::Prepend
-        member.name.to_s
-      when Members::ClassVariable, Members::ClassInstanceVariable, Members::InstanceVariable
-        member.name.to_s
-      when Members::AttrAccessor, Members::AttrWriter, Members::AttrReader
-        member.name.to_s
-      when Members::MethodDefinition
-        member.name.to_s
-      when Members::Alias
-        member.new_name.to_s
-      when Declarations::Constant
-        member.name.to_s
-      when Declarations::TypeAlias
-        member.name.to_s
-      when Declarations::Class, Declarations::Module, Declarations::Interface
-        member.name.to_s
-      else
-        raise
-      end
-    end
-
     def sort_decl!(decl)
       case decl
       when Declarations::Class, Declarations::Module, Declarations::Interface
+        partitioned = {
+          type_alias_decls: [],
+          constant_decls: [],
+          class_decls: [],
+          mixin_includes: [],
+          mixin_prepends: [],
+          mixin_extends: [],
+          class_variables: [],
+          class_instance_variables: [],
+          instance_variables: [],
+          singleton_attributes: [],
+          instance_attributes: [],
+          module_functions: [],
+          singleton_new_methods: [],
+          public_singleton_methods: [],
+          private_singleton_methods: [],
+          instance_initialize_methods: [],
+          public_instance_methods: [],
+          private_instance_methods: [],
+        } #: partitioned
+
         decl.members.each { |m| sort_decl! m }
 
-        current_visibility = :public
-        decl.members.map! do |m|
-          case m
+        visibility_annotated_members = [] #: Array[member]
+
+        decl.members.inject(:public) do |current_visibility, member| #$ AST::Members::visibility
+          case member
           when Members::Public
-            current_visibility = :public
-            nil
+            :public
           when Members::Private
-            current_visibility = :private
-            nil
+            :private
           when Members::MethodDefinition, Members::AttrReader, Members::AttrWriter, Members::AttrAccessor
-            m.update(visibility: m.visibility || current_visibility)
+            visibility_annotated_members << member.update(visibility: member.visibility || current_visibility)
+            current_visibility
           else
-            m
+            visibility_annotated_members << member
+            current_visibility
           end
         end
-        decl.members.compact!
-
-        decl.members.sort! do |m1, m2|
-          group1 = group(m1)
-          group2 = group(m2)
 
-          if group1 == group2
-            key(m1) <=> key(m2)
-          else
-            group1 <=> group2
-          end
-        end
-
-        current_visibility = :public
-        decl.members.map! do |m|
-          case m
-          when Members::MethodDefinition, Members::AttrReader, Members::AttrWriter, Members::AttrAccessor
-            new = m.update(visibility: nil)
-            cur = current_visibility
-            current_visibility = m.visibility
-            if cur != m.visibility
-              [
-                m.visibility == :public ? Members::Public.new(location: nil) : Members::Private.new(location: nil),
-                new
-              ]
+        visibility_annotated_members.each do |member|
+          case member
+          when Declarations::TypeAlias
+            partitioned[:type_alias_decls] << member
+          when Declarations::Constant
+            partitioned[:constant_decls] << member
+          when Declarations::Class, Declarations::Module, Declarations::Interface
+            partitioned[:class_decls] << member
+          when Members::Include
+            partitioned[:mixin_includes] << member
+          when Members::Prepend
+            partitioned[:mixin_prepends] << member
+          when Members::Extend
+            partitioned[:mixin_extends] << member
+          when Members::ClassVariable
+            partitioned[:class_variables] << member
+          when Members::ClassInstanceVariable
+            partitioned[:class_instance_variables] << member
+          when Members::InstanceVariable
+            partitioned[:instance_variables] << member
+          when Members::AttrAccessor, Members::AttrWriter, Members::AttrReader
+            if member.kind == :singleton
+              partitioned[:singleton_attributes] << member.update(visibility: nil)
+            else
+              partitioned[:instance_attributes] << member.update(visibility: nil)
+            end
+          when Members::MethodDefinition
+            case member.kind
+            when :singleton_instance
+              partitioned[:module_functions] << member.update(visibility: nil)
+            when :singleton
+              if member.name == :new
+                partitioned[:singleton_new_methods] << member.update(visibility: nil)
+              elsif member.visibility == :public
+                partitioned[:public_singleton_methods] << member.update(visibility: nil)
+              else
+                partitioned[:private_singleton_methods] << member.update(visibility: nil)
+              end
             else
-              new
+              if member.name == :initialize
+                partitioned[:instance_initialize_methods] << member.update(visibility: nil)
+              elsif member.visibility == :public
+                partitioned[:public_instance_methods] << member.update(visibility: nil)
+              else
+                partitioned[:private_instance_methods] << member.update(visibility: nil)
+              end
             end
+          when Members::Alias
+            if member.singleton?
+              partitioned[:public_singleton_methods] << member
+            else
+              partitioned[:public_instance_methods] << member
+            end
+          when Members::Public, Members::Private
+            raise
           else
-            m
+            partitioned[:other_decls] << member
           end
         end
-        decl.members.flatten!
+
+        partitioned[:type_alias_decls].sort_by! {|decl| decl.name.to_s }
+        partitioned[:constant_decls].sort_by! {|decl| decl.name.to_s }
+        partitioned[:class_decls].sort_by! {|decl| decl.name.to_s }
+        partitioned[:mixin_includes].sort_by! {|decl| decl.name.to_s }
+        partitioned[:mixin_prepends].sort_by! {|decl| decl.name.to_s }
+        partitioned[:mixin_extends].sort_by! {|decl| decl.name.to_s }
+        partitioned[:class_variables].sort_by! {|decl| decl.name.to_s }
+        partitioned[:class_instance_variables].sort_by! {|decl| decl.name.to_s }
+        partitioned[:instance_variables].sort_by! {|decl| decl.name.to_s }
+        partitioned[:singleton_attributes].sort_by! {|decl| decl.name.to_s }
+        partitioned[:instance_attributes].sort_by! {|decl| decl.name.to_s }
+        partitioned[:module_functions].sort_by! {|decl| decl.name.to_s }
+        partitioned[:public_singleton_methods].sort_by! {|decl| decl.is_a?(Members::MethodDefinition) ? decl.name.to_s : decl.new_name.to_s }
+        partitioned[:private_singleton_methods].sort_by! {|decl| decl.name.to_s }
+        partitioned[:public_instance_methods].sort_by! {|decl| decl.is_a?(Members::MethodDefinition) ? decl.name.to_s : decl.new_name.to_s }
+        partitioned[:private_instance_methods].sort_by! {|decl| decl.name.to_s }
+
+        members = [] #: Array[member]
+        members.push(*partitioned[:type_alias_decls])
+        members.push(*partitioned[:constant_decls])
+        members.push(*partitioned[:class_decls])
+        members.push(*partitioned[:mixin_includes])
+        members.push(*partitioned[:mixin_prepends])
+        members.push(*partitioned[:mixin_extends])
+        members.push(*partitioned[:class_variables])
+        members.push(*partitioned[:class_instance_variables])
+        members.push(*partitioned[:instance_variables])
+        members.push(*partitioned[:module_functions])
+        members.push(*partitioned[:singleton_attributes])
+
+        current_visibility = :public #: AST::Members::visibility
+
+        members.push(*partitioned[:singleton_new_methods])
+        members.push(*partitioned[:public_singleton_methods])
+
+        if !partitioned[:private_singleton_methods].empty?
+          current_visibility = :private
+          members.push Members::Private.new(location: nil)
+        end
+        members.push(*partitioned[:private_singleton_methods])
+
+        if current_visibility == :private && !partitioned[:public_instance_methods].empty?
+          current_visibility = :public
+          members.push Members::Public.new(location: nil)
+        end
+        members.push(*partitioned[:instance_attributes])
+        members.push(*partitioned[:instance_initialize_methods])
+        members.push(*partitioned[:public_instance_methods])
+
+        if current_visibility == :public && !partitioned[:private_instance_methods].empty?
+          current_visibility = :private
+          members.push Members::Private.new(location: nil)
+        end
+        members.push(*partitioned[:private_instance_methods])
+
+        members.push(*partitioned[:other_decls])
+
+        decl.members.replace(_ = members)
       end
     end
   end

data/lib/rbs/test/guaranteed.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RBS
+  module Test
+    module Guaranteed
+      module Inspect
+        EQUAL = ::BasicObject.instance_method(:equal?)
+        INSPECT = ::Kernel.instance_method(:inspect)
+        private_constant :EQUAL, :INSPECT
+
+        module_function def guaranteed_inspect(obj)
+          obj.inspect
+        rescue NoMethodError => err
+          raise unless err.name == :inspect && EQUAL.bind_call(obj, err.receiver)
+          INSPECT.bind_call(obj)
+        end
+
+        def inspect
+          string = "<#{self.class.name}:"
+
+          instance_variables.each_with_index do |variable, index|
+            string.concat ', ' unless index.zero?
+            string.concat "#{variable}: #{guaranteed_inspect(variable)}"
+          end
+
+          string.concat '>'
+        end
+      end
+    end
+  end
+end

data/lib/rbs/test/type_check.rb

@@ -136,7 +136,7 @@ module RBS
       end
 
       def keyword?(value)
-        value.is_a?(Hash) && value.keys.all? {|key| key.is_a?(Symbol) }
+        Hash === value && value.each_key.all?(Symbol)
       end
 
       def zip_args(args, fun, &block)
@@ -302,7 +302,7 @@ module RBS
           val.is_a?(singleton_class)
         when Types::Interface
           methods = Set.new(Test.call(val, METHODS))
-          if (definition = builder.build_interface(type.name))
+          if (definition = builder.build_interface(type.name.absolute!))
             definition.methods.each_key.all? do |method_name|
               methods.member?(method_name)
             end
@@ -310,7 +310,7 @@ module RBS
         when Types::Variable
           true
         when Types::Literal
-          val == type.literal
+          type.literal == val
         when Types::Union
           type.types.any? {|type| value(val, type) }
         when Types::Intersection
@@ -318,7 +318,7 @@ module RBS
         when Types::Optional
           Test.call(val, IS_AP, ::NilClass) || value(val, type.type)
         when Types::Alias
-          value(val, builder.expand_alias(type.name))
+          value(val, builder.expand_alias2(type.name.absolute!, type.args))
         when Types::Tuple
           Test.call(val, IS_AP, ::Array) &&
             type.types.map.with_index {|ty, index| value(val[index], ty) }.all?

data/lib/rbs/test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "securerandom"
+require "rbs/test/guaranteed"
 require "rbs/test/observer"
 require "rbs/test/spy"
 require "rbs/test/errors"
@@ -23,6 +24,8 @@ module RBS
     METHODS = Kernel.instance_method(:methods)
 
     class ArgumentsReturn
+      include Guaranteed::Inspect
+
       attr_reader :arguments
       attr_reader :exit_value
       attr_reader :exit_type

data/lib/rbs/types.rb

@@ -73,7 +73,7 @@ module RBS
           when Types::Bases::Void
             'void'
           when Types::Bases::Any
-            'untyped'
+            raise
           when Types::Bases::Nil
             'nil'
           when Types::Bases::Top
@@ -90,11 +90,32 @@ module RBS
             raise "Unexpected base type: #{inspect}"
           end
         end
+
+        def has_self_type?
+          self.is_a?(Types::Bases::Self)
+        end
+
+        def has_classish_type?
+          self.is_a?(Bases::Instance) || self.is_a?(Bases::Class)
+        end
+
+        def with_nonreturn_void?
+          self.is_a?(Bases::Void)
+        end
       end
 
       class Bool < Base; end
       class Void < Base; end
-      class Any < Base; end
+      class Any < Base
+        def to_s(level=0)
+          @string || "untyped"
+        end
+
+        def todo!
+          @string = '__todo__'
+          self
+        end
+      end
       class Nil < Base; end
       class Top < Base; end
       class Bottom < Base; end
@@ -162,6 +183,18 @@ module RBS
       end
 
       include EmptyEachType
+
+      def has_self_type?
+        false
+      end
+
+      def has_classish_type?
+        false
+      end
+
+      def with_nonreturn_void?
+        false
+      end
     end
 
     class ClassSingleton
@@ -202,6 +235,18 @@ module RBS
           location: location
         )
       end
+
+      def has_self_type?
+        false
+      end
+
+      def has_classish_type?
+        false
+      end
+
+      def with_nonreturn_void?
+        false
+      end
     end
 
     module Application
@@ -241,6 +286,25 @@ module RBS
           enum_for :each_type
         end
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        each_type.any? do |type|
+          if type.is_a?(Bases::Void)
+            # `void` in immediate generics parameter is allowed
+            false
+          else
+            type.with_nonreturn_void?
+          end
+        end
+      end
     end
 
     class Interface
@@ -436,6 +500,18 @@ module RBS
           enum_for :map_type
         end
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        each_type.any? {|type| type.with_nonreturn_void? }
+      end
     end
 
     class Record
@@ -478,7 +554,7 @@ module RBS
         return "{ }" if self.fields.empty?
 
         fields = self.fields.map do |key, type|
-          if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_]*\z/)
+          if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_0-9]*\z/)
             "#{key}: #{type}"
           else
             "#{key.inspect} => #{type}"
@@ -512,6 +588,18 @@ module RBS
           enum_for :map_type
         end
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        each_type.any? {|type| type.with_nonreturn_void? }
+      end
     end
 
     class Optional
@@ -552,6 +640,8 @@ module RBS
           when Symbol
             return "#{type.to_s(1)} ?"
           end
+        when RBS::Types::Proc
+          return "(#{type.to_s(1)})?"
         end
 
         "#{type.to_s(1)}?"
@@ -582,6 +672,18 @@ module RBS
           enum_for :map_type
         end
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        each_type.any? {|type| type.with_nonreturn_void? }
+      end
     end
 
     class Union
@@ -650,6 +752,18 @@ module RBS
           location: location
         )
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        each_type.any? {|type| type.with_nonreturn_void? }
+      end
     end
 
     class Intersection
@@ -719,6 +833,18 @@ module RBS
           location: location
         )
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        each_type.any? {|type| type.with_nonreturn_void? }
+      end
     end
 
     class Function
@@ -1029,6 +1155,26 @@ module RBS
           false
         end
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        if each_param.any? {|param| param.type.with_nonreturn_void? }
+          true
+        else
+          if return_type.is_a?(Bases::Void)
+            false
+          else
+            return_type.with_nonreturn_void?
+          end
+        end
+      end
     end
 
     class Block
@@ -1155,6 +1301,9 @@ module RBS
         if block
           type.each_type(&block)
           self.block&.type&.each_type(&block)
+          if self_type = self.block&.self_type
+            yield self_type
+          end
         else
           enum_for :each_type
         end
@@ -1181,6 +1330,26 @@ module RBS
           enum_for :map_type
         end
       end
+
+      def has_self_type?
+        each_type.any? {|type| type.has_self_type? }
+      end
+
+      def has_classish_type?
+        each_type.any? {|type| type.has_classish_type? }
+      end
+
+      def with_nonreturn_void?
+        if type.with_nonreturn_void?
+          true
+        else
+          if block = block()
+            block.type.with_nonreturn_void? || block.self_type&.with_nonreturn_void? || false
+          else
+            false
+          end
+        end
+      end
     end
 
     class Literal
@@ -1214,6 +1383,18 @@ module RBS
       def to_s(level = 0)
         literal.inspect
       end
+
+      def has_self_type?
+        false
+      end
+
+      def has_classish_type?
+        false
+      end
+
+      def with_nonreturn_void?
+        false
+      end
     end
   end
 end

data/lib/rbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBS
-  VERSION = "3.2.2"
+  VERSION = "3.3.0.pre.1"
 end

data/lib/rbs/writer.rb

@@ -107,7 +107,7 @@ module RBS
           "#{clause.namespace}*"
         end
       end
-      
+
       puts "use #{clauses.join(", ")}"
     end
 
@@ -264,8 +264,8 @@ module RBS
       when AST::Members::Alias
         write_comment member.comment
         write_annotation member.annotations
-        new_name = member.singleton? ? "self.#{member.new_name}" : member.new_name
-        old_name = member.singleton? ? "self.#{member.old_name}" : member.old_name
+        new_name = member.singleton? ? "self.#{method_name(member.new_name)}" : method_name(member.new_name)
+        old_name = member.singleton? ? "self.#{method_name(member.old_name)}" : method_name(member.old_name)
         puts "alias #{new_name} #{old_name}"
       when AST::Members::InstanceVariable
         write_comment member.comment
@@ -385,7 +385,7 @@ module RBS
                    ""
                  end
 
-      "#{visibility}attr_#{kind} #{receiver}#{attr.name}#{var}: #{attr.type}"
+      "#{visibility}attr_#{kind} #{receiver}#{method_name(attr.name)}#{var}: #{attr.type}"
     end
 
     def preserve_empty_line(prev, decl)