parlour 3.0.0 → 5.0.0.beta.3

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,8 +271,8 @@ module Parlour
         params(
           name: String,
           parameters: T.nilable(T::Array[Parameter]),
-          return_type: T.nilable(String),
-          returns: T.nilable(String),
+          return_type: T.nilable(Types::TypeLike),
+          returns: T.nilable(Types::TypeLike),
           abstract: T::Boolean,
           implementation: T::Boolean,
           override: 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)
@@ -527,7 +538,7 @@ module Parlour
         returned_includables
       end
 
-      sig { params(name: String, value: String, block: T.nilable(T.proc.params(x: Constant).void)).returns(Constant) }
+      sig { params(name: String, value: String, eigen_constant: T::Boolean, block: T.nilable(T.proc.params(x: Constant).void)).returns(Constant) }
       # Adds a new constant definition to this namespace.
       #
       # @example Add an +Elem+ constant to the class.
@@ -535,13 +546,16 @@ module Parlour
       #
       # @param name [String] The name of the constant.
       # @param value [String] The value of the constant, as a Ruby code string.
+      # @param eigen_constant [Boolean] Whether this constant is defined on the
+      #   eigenclass of the current namespace.
       # @param block A block which the new instance yields itself to.
       # @return [RbiGenerator::Constant]
-      def create_constant(name, value:, &block)
+      def create_constant(name, value:, eigen_constant: false, &block)
         new_constant = RbiGenerator::Constant.new(
           generator,
           name: name,
           value: value,
+          eigen_constant: eigen_constant,
           &block
         )
         move_next_comments(new_constant)
@@ -549,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.
@@ -560,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
@@ -612,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
@@ -631,14 +658,22 @@ module Parlour
 
         result += [options.indented(indent_level, 'final!'), ''] if final
 
-        if includes.any? || extends.any? || constants.any?
+        # Split away the eigen constants; these need to be put in a
+        # "class << self" block later
+        eigen_constants, non_eigen_constants = constants.partition(&:eigen_constant)
+        eigen_constants.sort_by!(&:name) if options.sort_namespaces
+
+        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 ? constants.sort_by(&:name) : constants)
+          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 == '' }
           result << ""
@@ -658,21 +693,36 @@ module Parlour
           child.is_a?(Attribute) && child.class_attribute
         end
 
-        if class_attributes.any?
-          result << options.indented(indent_level, 'class << self')
+        # Handle the "class << self block"
+        result << options.indented(indent_level, 'class << self') \
+          if class_attributes.any? || eigen_constants.any?
+
+        if eigen_constants.any?
+          first, *rest = eigen_constants
+          result += T.must(first).generate_rbi(indent_level + 1, options) + T.must(rest)
+            .map { |obj| obj.generate_rbi(indent_level + 1, options) }
+            .map { |lines| [""] + lines }
+            .flatten
+        end
+
+        result << '' if eigen_constants.any? && class_attributes.any?
 
+        if class_attributes.any?
           first, *rest = class_attributes
           result += T.must(first).generate_rbi(indent_level + 1, options) + T.must(rest)
             .map { |obj| obj.generate_rbi(indent_level + 1, options) }
             .map { |lines| [""] + lines }
             .flatten
+        end
+
+        if class_attributes.any? || eigen_constants.any?
           result << options.indented(indent_level, 'end')
           result << ''
         end
 
         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

data/lib/parlour/rbi_generator/parameter.rb

@@ -1,6 +1,7 @@
 # typed: true
+require 'rainbow'
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # Represents a method parameter with a Sorbet type signature.
     class Parameter
       extend T::Sig
@@ -8,7 +9,7 @@ module Parlour
       sig do
         params(
           name: String,
-          type: T.nilable(String),
+          type: T.nilable(Types::TypeLike),
           default: T.nilable(String)
         ).void
       end
@@ -42,7 +43,7 @@ module Parlour
 
         @kind = :keyword if kind == :normal && name.end_with?(':')
 
-        @type = type
+        @type = type || 'T.untyped'
         @default = default
       end
 
@@ -80,10 +81,10 @@ module Parlour
         T.must(name[prefix.length..-1])
       end
 
-      sig { returns(T.nilable(String)) }
+      sig { returns(Types::TypeLike) }
       # A Sorbet string of this parameter's type, such as +"String"+ or
       # +"T.untyped"+.
-      # @return [String, nil]
+      # @return [String]
       attr_reader :type
 
       sig { returns(T.nilable(String)) }
@@ -118,8 +119,8 @@ module Parlour
       #
       # @return [String]
       def to_sig_param
-        "#{name_without_kind}: #{type || 'T.untyped'}"
-      end#
+        "#{name_without_kind}: #{String === @type ? @type : @type.generate_rbi}"
+      end
 
       # A mapping of {kind} values to the characteristic prefixes each kind has.
       PREFIXES = {
@@ -128,6 +129,11 @@ module Parlour
         double_splat: '**',
         block: '&'
       }.freeze
+
+      sig { void }
+      def generalize_from_rbi!
+        @type = TypeParser.parse_single_type(@type) if String === @type
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/rbi_object.rb

@@ -1,17 +1,15 @@
 # typed: true
 module Parlour
-  class RbiGenerator
+  class RbiGenerator < Generator
     # An abstract class which is subclassed by any classes which can generate
     # entire lines of an RBI, such as {Namespace} and {Method}. (As an example,
     # {Parameter} is _not_ a subclass because it does not generate lines, only
     # segments of definition and signature lines.)
     # @abstract
-    class RbiObject
-      extend T::Helpers
-      extend T::Sig
+    class RbiObject < TypedObject
       abstract!
-
-      sig { params(generator: RbiGenerator, name: String).void }
+      
+      sig { params(generator: Generator, name: String).void }
       # Creates a new RBI object.
       # @note Don't call this directly.
       #
@@ -19,60 +17,16 @@ module Parlour
       # @param name [String] The name of this module.
       # @return [void]
       def initialize(generator, name)
+        super(name)
         @generator = generator
-        @generated_by = generator.current_plugin
-        @name = name
-        @comments = []
+        @generated_by = RbiGenerator === generator ? generator.current_plugin : nil
       end
 
-      sig { returns(RbiGenerator) }
+      sig { returns(Generator) }
       # The generator which this object belongs to.
-      # @return [RbiGenerator]
+      # @return [Generator]
       attr_reader :generator
 
-      sig { returns(T.nilable(Plugin)) }
-      # The {Plugin} which was controlling the {generator} when this object was
-      # created.
-      # @return [Plugin, nil]
-      attr_reader :generated_by
-
-      sig { returns(String) }
-      # The name of this object.
-      # @return [String]
-      attr_reader :name
-
-      sig { returns(T::Array[String]) }
-      # An array of comments which will be placed above the object in the RBI
-      # file.
-      # @return [Array<String>]
-      attr_reader :comments
-
-      sig { params(comment: T.any(String, T::Array[String])).void }
-      # Adds one or more comments to this RBI object. Comments always go above 
-      # the definition for this object, not in the definition's body.
-      #
-      # @example Creating a module with a comment.
-      #   namespace.create_module('M') do |m|
-      #     m.add_comment('This is a module')
-      #   end
-      #
-      # @example Creating a class with a multi-line comment.
-      #   namespace.create_class('C') do |c|
-      #     c.add_comment(['This is a multi-line comment!', 'It can be as long as you want!'])
-      #   end
-      #
-      # @param comment [String, Array<String>] The new comment(s).
-      # @return [void]
-      def add_comment(comment)
-        if comment.is_a?(String)
-          comments << comment
-        elsif comment.is_a?(Array)
-          comments.concat(comment)
-        end
-      end
-
-      alias_method :add_comments, :add_comment
-
       sig do
         abstract.params(
           indent_level: Integer,
@@ -115,32 +69,19 @@ module Parlour
       # @return [void]
       def merge_into_self(others); end
 
-      sig { abstract.returns(String) }
-      # Returns a human-readable brief string description of this object. This
-      # is displayed during manual conflict resolution with the +parlour+ CLI.
-      #
-      # @abstract
-      # @return [String]
-      def describe; end
-      
-      private
-
-      sig do
-        params(
-          indent_level: Integer,
-          options: Options
-        ).returns(T::Array[String])
+      sig { override.overridable.returns(String) }
+      def describe
+        'RBI object'
       end
-      # Generates the RBI lines for this object's comments.
+
+      sig { abstract.void }
+      # Assuming that the types throughout this object and its children have
+      # been specified as RBI-style types, generalises them into type instances
+      # from the {Parlour::Types} module.
       #
-      # @param indent_level [Integer] The indentation level to generate the lines at.
-      # @param options [Options] The formatting options to use.
-      # @return [Array<String>] The RBI lines for each comment, formatted as specified.
-      def generate_comments(indent_level, options)
-        comments.any? \
-          ? comments.map { |c| options.indented(indent_level, "# #{c}") }
-          : []
-      end
+      # @abstract
+      # @return [void]
+      def generalize_from_rbi!; end
     end
   end
 end