parlour 4.0.1 → 5.0.0.beta.1

data/lib/parlour/rbi_generator/arbitrary.rb

@@ -1,11 +1,11 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents miscellaneous Ruby code.
     class Arbitrary < RbiObject
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           code: String,
           block: T.nilable(T.proc.params(x: Arbitrary).void)
         ).void
@@ -87,6 +87,9 @@ module Parlour
       def describe
         "Arbitrary code (#{code})"
       end
+
+      sig { override.void }
+      def generalize_from_rbi!; end # Nothing to do
     end
   end
 end

data/lib/parlour/rbi_generator/attribute.rb

@@ -1,14 +1,14 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents an attribute reader, writer or accessor.
     class Attribute < Method
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
           kind: Symbol,
-          type: String,
+          type: Types::TypeLike,
           class_attribute: T::Boolean,
           block: T.nilable(T.proc.params(x: Attribute).void)
         ).void
@@ -20,8 +20,7 @@ module Parlour
       # @param name [String] The name of this attribute.
       # @param kind [Symbol] The kind of attribute this is; one of :writer, :reader or
       #   :accessor.
-      # @param type [String] A Sorbet string of this attribute's type, such as
-      #   +"String"+ or +"T.untyped"+.
+      # @param type [String, Types::Type] This attribute's type.
       # @param class_attribute [Boolean] Whether this attribute belongs to the
       #   singleton class.
       # @param block A block which the new instance yields itself to.
@@ -32,6 +31,7 @@ module Parlour
         # attr_accessor and attr_reader should have: sig { returns(X) }
         # attr_writer :foo should have: sig { params(foo: X).returns(X) }
 
+        @type = type
         @kind = kind
         @class_attribute = class_attribute
         case kind
@@ -55,6 +55,10 @@ module Parlour
       # Whether this attribute belongs to the singleton class.
       attr_reader :class_attribute
 
+      sig { returns(Types::TypeLike) }
+      # The type of this attribute.
+      attr_reader :type
+
       sig { override.params(other: Object).returns(T::Boolean) }
       # Returns true if this instance is equal to another attribute.
       #
@@ -69,6 +73,11 @@ module Parlour
         )
       end
 
+      sig { override.void }
+      def generalize_from_rbi!
+        @type = TypeParser.parse_single_type(@type) if String === @type
+      end
+
       private
 
       sig do

data/lib/parlour/rbi_generator/class_namespace.rb

@@ -1,13 +1,13 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents a class definition.
     class ClassNamespace < Namespace
       extend T::Sig
 
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
           final: T::Boolean,
           superclass: T.nilable(String),
@@ -47,7 +47,7 @@ module Parlour
         class_definition = superclass.nil? \
           ? "class #{name}"
           : "class #{name} < #{superclass}"
-        
+    
         lines = generate_comments(indent_level, options)
         lines << options.indented(indent_level, class_definition)
         lines += [options.indented(indent_level + 1, "abstract!"), ""] if abstract
@@ -116,6 +116,11 @@ module Parlour
           "#{"abstract, " if abstract}#{children.length} children, " +
           "#{includes.length} includes, #{extends.length} extends"
       end
+
+      sig { override.void }
+      def generalize_from_rbi!
+        super
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/constant.rb

@@ -1,13 +1,13 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents a constant definition.
     class Constant < RbiObject
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
-          value: String,
+          value: Types::TypeLike,
           eigen_constant: T::Boolean,
           block: T.nilable(T.proc.params(x: Constant).void)
         ).void
@@ -25,8 +25,8 @@ module Parlour
         yield_self(&block) if block
       end
 
-      # @return [String] The value of the constant, as a Ruby code string.
-      sig { returns(String) }
+      # @return [String] The value or type of the constant.
+      sig { returns(Types::TypeLike) }
       attr_reader :value
 
       # @return [Boolean] Whether this constant is defined on the eigenclass
@@ -56,7 +56,11 @@ module Parlour
       # @param options [Options] The formatting options to use.
       # @return [Array<String>] The RBI lines, formatted as specified.
       def generate_rbi(indent_level, options)
-        [options.indented(indent_level, "#{name} = #{value}")]
+        if String === @value
+          [options.indented(indent_level, "#{name} = #{@value}")]
+        else
+          [options.indented(indent_level, "#{name} = T.let(nil, #{@value.generate_rbi})")]
+        end
       end
 
       sig do
@@ -98,6 +102,13 @@ module Parlour
       def describe
         "Constant (#{name} = #{value})"
       end
+
+      sig { override.void }
+      def generalize_from_rbi!
+        # There's a good change this is an untyped constant, so rescue
+        # ParseError and use untyped
+        @value = (TypeParser.parse_single_type(@value) if String === @value) rescue Types::Untyped.new
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/enum_class_namespace.rb

@@ -1,13 +1,13 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents an enum definition; that is, a class with an +enum+ call.
     class EnumClassNamespace < ClassNamespace
       extend T::Sig
 
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
           final: T::Boolean,
           enums: T::Array[T.any([String, String], String)],
@@ -38,7 +38,7 @@ module Parlour
       sig do
         override.params(
           indent_level: Integer,
-          options: Options
+          options: Options,
         ).returns(T::Array[String])
       end
       # Generates the RBI lines for the body of this enum. This consists of
@@ -107,6 +107,11 @@ module Parlour
           @enums = other.enums if enums.empty?
         end
       end
+
+      sig { override.void }
+      def generalize_from_rbi!
+        super
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/extend.rb

@@ -1,11 +1,11 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents an +extend+ call.
     class Extend < RbiObject
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
           block: T.nilable(T.proc.params(x: Extend).void)
         ).void
@@ -82,6 +82,9 @@ module Parlour
       def describe
         "Extend (#{name})"
       end
+
+      sig { override.void }
+      def generalize_from_rbi!; end # Nothing to do
     end
   end
 end

data/lib/parlour/rbi_generator/include.rb

@@ -1,11 +1,11 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents an +include+ call.
     class Include < RbiObject
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
           block: T.nilable(T.proc.params(x: Include).void)
         ).void
@@ -82,6 +82,9 @@ module Parlour
       def describe
         "Include (#{name})"
       end
+
+      sig { override.void }
+      def generalize_from_rbi!; end # Nothing to do
     end
   end
 end

data/lib/parlour/rbi_generator/method.rb

@@ -1,16 +1,16 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents a method definition.
     class Method < RbiObject
       extend T::Sig
 
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
           parameters: T::Array[Parameter],
-          return_type: T.nilable(String),
+          return_type: T.nilable(Types::TypeLike),
           abstract: T::Boolean,
           implementation: T::Boolean,
           override: T::Boolean,
@@ -29,8 +29,7 @@ module Parlour
       #   this - use the +class_method+ parameter instead.
       # @param parameters [Array<Parameter>] An array of {Parameter} instances representing this 
       #   method's parameters.
-      # @param return_type [String, nil] A Sorbet string of what this method returns, such as
-      #   +"String"+ or +"T.untyped"+. Passing nil denotes a void return.
+      # @param return_type [Types::TypeLike, nil] What this method returns. Passing nil denotes a void return.
       # @param abstract [Boolean] Whether this method is abstract.
       # @param implementation [Boolean] DEPRECATED: Whether this method is an 
       #   implementation of a parent abstract method.
@@ -82,10 +81,9 @@ module Parlour
       # @return [Array<Parameter>]
       attr_reader :parameters
 
-      sig { returns(T.nilable(String)) }
-      # A Sorbet string of what this method returns, such as "String" or
-      # "T.untyped". Passing nil denotes a void return.
-      # @return [String, nil]
+      sig { returns(T.nilable(Types::TypeLike)) }
+      # What this method returns. Passing nil denotes a void return.
+      # @return [Types::TypeLike, nil]
       attr_reader :return_type
 
       sig { returns(T::Boolean) }
@@ -140,7 +138,7 @@ module Parlour
       # @param options [Options] The formatting options to use.
       # @return [Array<String>] The RBI lines, formatted as specified.
       def generate_rbi(indent_level, options)
-        return_call = return_type ? "returns(#{return_type})" : 'void'
+        return_call = @return_type ? "returns(#{String === @return_type ? @return_type : @return_type.generate_rbi})" : 'void'
         sig_args = final ? '(:final)' : ''
 
         sig_params = parameters.map(&:to_sig_param)
@@ -218,6 +216,13 @@ module Parlour
           " returns #{return_type}"
       end
 
+      sig { override.void }
+      def generalize_from_rbi!
+        @return_type = TypeParser.parse_single_type(@return_type) if String === @return_type
+
+        parameters.each(&:generalize_from_rbi!)
+      end
+
       private
 
       sig do

data/lib/parlour/rbi_generator/module_namespace.rb

@@ -1,13 +1,13 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents a module definition.
     class ModuleNamespace < Namespace
       extend T::Sig
 
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: String,
           final: T::Boolean,
           interface: T::Boolean,
@@ -96,6 +96,11 @@ module Parlour
         "Module #{name} - #{"interface, " if interface}#{children.length} " +
           "children, #{includes.length} includes, #{extends.length} extends"
       end
+
+      sig { override.void }
+      def generalize_from_rbi!
+        super
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/namespace.rb

@@ -1,6 +1,6 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # A generic namespace. This shouldn't be used, except as the type of
     # {RbiGenerator#root}.
     class Namespace < RbiObject
@@ -24,7 +24,7 @@ module Parlour
 
       sig do
         params(
-          generator: RbiGenerator,
+          generator: Generator,
           name: T.nilable(String),
           final: T::Boolean,
           block: T.nilable(T.proc.params(x: Namespace).void)
@@ -77,6 +77,17 @@ module Parlour
         )
       end
 
+      sig { returns(T::Array[RbiGenerator::TypeAlias]) }
+      # The {RbiGenerator::TypeAlias} objects from {children}.
+      # @return [Array<RbiGenerator::TypeAlias>]
+      def aliases
+        T.cast(
+          children.select { |c| c.is_a?(RbiGenerator::TypeAlias) },
+          T::Array[RbiGenerator::TypeAlias]
+        )
+      end
+      alias type_aliases aliases
+
       sig { returns(T::Array[RbiGenerator::Constant]) }
       # The {RbiGenerator::Constant} objects from {children}.
       # @return [Array<RbiGenerator::Constant>]
@@ -260,7 +271,7 @@ module Parlour
         params(
           name: String,
           parameters: T.nilable(T::Array[Parameter]),
-          return_type: T.nilable(String),
+          return_type: T.nilable(Types::TypeLike),
           returns: T.nilable(String),
           abstract: T::Boolean,
           implementation: T::Boolean,
@@ -320,7 +331,7 @@ module Parlour
         params(
           name: String,
           kind: Symbol,
-          type: String,
+          type: Types::TypeLike,
           class_attribute: T::Boolean,
           block: T.nilable(T.proc.params(x: Attribute).void)
         ).returns(Attribute)
@@ -376,7 +387,7 @@ module Parlour
       sig do
         params(
           name: String,
-          type: String,
+          type: Types::TypeLike,
           class_attribute: T::Boolean,
           block: T.nilable(T.proc.params(x: Attribute).void)
         ).returns(Attribute)
@@ -397,7 +408,7 @@ module Parlour
       sig do
         params(
           name: String,
-          type: String,
+          type: Types::TypeLike,
           class_attribute: T::Boolean,
           block: T.nilable(T.proc.params(x: Attribute).void)
         ).returns(Attribute)
@@ -418,7 +429,7 @@ module Parlour
       sig do
         params(
           name: String,
-          type: String,
+          type: Types::TypeLike,
           class_attribute: T::Boolean,
           block: T.nilable(T.proc.params(x: Attribute).void)
         ).returns(Attribute)
@@ -552,7 +563,7 @@ module Parlour
         new_constant
       end
 
-      sig { params(name: String, type: String, block: T.nilable(T.proc.params(x: Constant).void)).returns(Constant) }
+      sig { params(name: String, type: Types::TypeLike, block: T.nilable(T.proc.params(x: TypeAlias).void)).returns(TypeAlias) }
       # Adds a new type alias, in the form of a constant, to this namespace.
       #
       # @example Add a +MyType+ type alias, to +Integer+, to the class.
@@ -563,7 +574,15 @@ module Parlour
       # @param block A block which the new instance yields itself to.
       # @return [RbiGenerator::Constant]
       def create_type_alias(name, type:, &block)
-        create_constant(name, value: "T.type_alias { #{type} }", &block)
+        new_type_alias = RbiGenerator::TypeAlias.new(
+          generator,
+          name: name,
+          type: type,
+          &block
+        )
+        move_next_comments(new_type_alias)
+        children << new_type_alias
+        new_type_alias
       end
 
       sig do
@@ -615,12 +634,17 @@ module Parlour
           "includes, #{extends.length} extends, #{constants.length} constants"
       end
 
+      sig { override.void }
+      def generalize_from_rbi!
+        children.each(&:generalize_from_rbi!)
+      end
+
       private
 
       sig do
         overridable.params(
           indent_level: Integer,
-          options: Options
+          options: Options,
         ).returns(T::Array[String])
       end
       # Generates the RBI lines for the body of this namespace. This consists of
@@ -639,13 +663,16 @@ module Parlour
         eigen_constants, non_eigen_constants = constants.partition(&:eigen_constant)
         eigen_constants.sort_by!(&:name) if options.sort_namespaces
 
-        if includes.any? || extends.any? || non_eigen_constants.any?
+        if includes.any? || extends.any? || aliases.any? || non_eigen_constants.any?
           result += (options.sort_namespaces ? includes.sort_by(&:name) : includes)
             .flat_map { |x| x.generate_rbi(indent_level, options) }
             .reject { |x| x.strip == '' }
           result += (options.sort_namespaces ? extends.sort_by(&:name) : extends)
             .flat_map { |x| x.generate_rbi(indent_level, options) }
             .reject { |x| x.strip == '' }
+          result += (options.sort_namespaces ? aliases.sort_by(&:name) : aliases)
+            .flat_map { |x| x.generate_rbi(indent_level, options) }
+            .reject { |x| x.strip == '' }
           result += (options.sort_namespaces ? non_eigen_constants.sort_by(&:name) : non_eigen_constants)
             .flat_map { |x| x.generate_rbi(indent_level, options) }
             .reject { |x| x.strip == '' }
@@ -695,7 +722,7 @@ module Parlour
 
         first, *rest = remaining_children.reject do |child|
           # We already processed these kinds of children
-          child.is_a?(Include) || child.is_a?(Extend) || child.is_a?(Constant)
+          child.is_a?(Include) || child.is_a?(Extend) || child.is_a?(Constant) || child.is_a?(TypeAlias)
         end
         unless first
           # Remove any trailing whitespace due to includes or class attributes