parlour 5.0.0 → 7.0.0

data/lib/parlour/rbi_generator/namespace.rb

@@ -5,6 +5,7 @@ module Parlour
     # {RbiGenerator#root}.
     class Namespace < RbiObject
       extend T::Sig
+      extend T::Generic
 
       sig do
         override.overridable.params(
@@ -60,11 +61,14 @@ module Parlour
       # @return [Boolean]
       attr_reader :sealed
 
-      sig { returns(T::Array[RbiObject]) }
+      sig { override.returns(T::Array[RbiObject]).checked(:never) }
       # The child {RbiObject} instances inside this namespace.
       # @return [Array<RbiObject>]
       attr_reader :children
 
+      include Mixin::Searchable
+      Child = type_member {{ fixed: RbiObject }}
+
       sig { returns(T::Array[RbiGenerator::Extend]) }
       # The {RbiGenerator::Extend} objects from {children}.
       # @return [Array<RbiGenerator::Extend>]
@@ -106,28 +110,31 @@ module Parlour
         )
       end
 
-      sig { params(object: T.untyped, block: T.proc.params(x: Namespace).void).void }
-      # Given a Class or Module object, generates all classes and modules in the
-      # path to that object, then executes the given block on the last
-      # {Namespace}. This should only be executed on the root namespace.
-      # @param [Class, Module] object
+      sig { params(constant: Module, block: T.proc.params(x: Namespace).void).void }
+      # Given a constant (i.e. a Module instance), generates all classes
+      # and modules in the path to that object, then executes the given
+      # block on the last {Namespace}. This should only be executed on
+      # the root namespace.
+      # @param [Module] constant
       # @param block A block which the new {Namespace} yields itself to.
-      def path(object, &block)
+      def path(constant, &block)
         raise 'only call #path on root' if is_a?(ClassNamespace) || is_a?(ModuleNamespace)
 
-        parts = object.to_s.split('::')
-        parts_with_types = parts.size.times.map do |i|
-          [parts[i], Module.const_get(parts[0..i].join('::')).class]
-        end
+        constant_name = T.let(Module.instance_method(:name).bind(constant).call, T.nilable(String))
+        raise 'given constant does not have a name' unless constant_name
 
         current_part = self
-        parts_with_types.each do |(name, type)|
-          if type == Class
+        constant_name.split('::').each_with_object([]) do |name, namespace|
+          namespace << name
+          instance = Module.const_get(namespace.join("::"))
+
+          case instance
+          when Class
             current_part = current_part.create_class(name)
-          elsif type == Module
+          when Module
             current_part = current_part.create_module(name)
           else
-            raise "unexpected type: path part #{name} is a #{type}"
+            raise "unexpected type: path part #{name} is a #{instance.class}"
           end
         end
 
@@ -644,20 +651,16 @@ module Parlour
         end
       end
 
-      sig { override.overridable.returns(String) }
-      # Returns a human-readable brief string description of this namespace.
-      #
-      # @return [String]
-      def describe
-        "Namespace #{name} - #{children.length} children, #{includes.length} " +
-          "includes, #{extends.length} extends, #{constants.length} constants"
-      end
-
       sig { override.void }
       def generalize_from_rbi!
         children.each(&:generalize_from_rbi!)
       end
 
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [:children, :final, :sealed]
+      end
+
       private
 
       sig do

data/lib/parlour/rbi_generator/parameter.rb

@@ -134,6 +134,18 @@ module Parlour
       def generalize_from_rbi!
         @type = TypeParser.parse_single_type(@type) if String === @type
       end
+
+      sig { returns(String) }
+      def describe_in_method
+        t = type
+        t = t.is_a?(String) ? t : t.describe
+
+        if default
+          "#{name}: #{t} = #{default}"
+        else
+          "#{name}: #{t}"
+        end
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/rbi_object.rb

@@ -69,11 +69,6 @@ module Parlour
       # @return [void]
       def merge_into_self(others); end
 
-      sig { override.overridable.returns(String) }
-      def describe
-        'RBI object'
-      end
-
       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

data/lib/parlour/rbi_generator/struct_class_namespace.rb

@@ -6,6 +6,8 @@ module Parlour
     class StructClassNamespace < ClassNamespace
       extend T::Sig
 
+      Child = type_member {{ fixed: RbiObject }}
+
       sig do
         params(
           generator: Generator,
@@ -107,6 +109,11 @@ module Parlour
 
         props.each(&:generalize_from_rbi!)
       end
+
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        super + [{props: "(#{props.map(&:name)})"}]
+      end
     end
   end
 end

data/lib/parlour/rbi_generator/type_alias.rb

@@ -84,18 +84,15 @@ module Parlour
         # We don't need to change anything! We only merge identical type alias
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this code.
-      #
-      # @return [String]
-      def describe
-        "Type Alias (#{name} = #{type})"
-      end
-
       sig { override.void }
       def generalize_from_rbi!
         @type = TypeParser.parse_single_type(@type) if String === @type
       end
+
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [{type: type}] # avoid quotes
+      end
     end
   end
 end

data/lib/parlour/rbi_generator.rb

@@ -21,22 +21,7 @@ module Parlour
     #
     # @return [String] The generated RBI file
     def rbi(strictness = 'strong')
-      # TODO: Early test option - convert to RBS if requested
-      # Absolutely remove this later on
-      if ENV['PARLOUR_CONVERT_TO_RBS']
-        # Perform conversion
-        root.generalize_from_rbi!
-        rbs_gen = Parlour::RbsGenerator.new
-        converter = Parlour::Conversion::RbiToRbs.new(rbs_gen)
-        root.children.each do |child|
-          converter.convert_object(child, rbs_gen.root)
-        end
-
-        # Write the final RBS
-        rbs_gen.rbs
-      else
-        "# typed: #{strictness}\n" + root.generate_rbi(0, options).join("\n") + "\n"
-      end
+      "# typed: #{strictness}\n" + root.generate_rbi(0, options).join("\n") + "\n"
     end
   end
 end

data/lib/parlour/rbs_generator/arbitrary.rb

@@ -80,12 +80,9 @@ module Parlour
         raise 'arbitrary code is never mergeable'
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this code.
-      #
-      # @return [String]
-      def describe
-        "Arbitrary code (#{code})"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [:code]
       end
     end
   end

data/lib/parlour/rbs_generator/attribute.rb

@@ -77,6 +77,14 @@ module Parlour
           super(other) && Attribute === other && kind == other.kind
         )
       end
+
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [
+          :kind,
+          :class_attribute
+        ]
+      end
     end
   end
 end

data/lib/parlour/rbs_generator/class_namespace.rb

@@ -5,6 +5,8 @@ module Parlour
     class ClassNamespace < Namespace
       extend T::Sig
 
+      Child = type_member {{ fixed: RbsObject }}
+
       sig do
         params(
           generator: Generator,
@@ -18,10 +20,8 @@ module Parlour
       #
       # @param generator [RbsGenerator] The current RbsGenerator.
       # @param name [String] The name of this class.
-      # @param final [Boolean] Whether this namespace is final.
       # @param superclass [String, nil] The superclass of this class, or nil if it doesn't
       #   have one.
-      # @param abstract [Boolean] A boolean indicating whether this class is abstract.
       # @param block A block which the new instance yields itself to.
       # @return [void]
       def initialize(generator, name, superclass, &block)
@@ -93,13 +93,9 @@ module Parlour
         end
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this class.
-      # @return [String]
-      def describe
-        "Class #{name} - #{"superclass #{superclass}, " if superclass}" +
-          "#{children.length} children, " +
-          "#{includes.length} includes, #{extends.length} extends"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        (superclass ? [:superclass] : []) + [:children]
       end
     end
   end

data/lib/parlour/rbs_generator/constant.rb

@@ -83,12 +83,9 @@ module Parlour
         # We don't need to change anything! We only merge identical constants
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this code.
-      #
-      # @return [String]
-      def describe
-        "Constant (#{name} = #{type})"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [{type: type}] # avoid quotes
       end
     end
   end

data/lib/parlour/rbs_generator/extend.rb

@@ -80,12 +80,9 @@ module Parlour
         # We don't need to change anything! We only merge identical extends
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this code.
-      #
-      # @return [String]
-      def describe
-        "Extend (#{@type})"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [{type: type}] # avoid quotes
       end
     end
   end

data/lib/parlour/rbs_generator/include.rb

@@ -80,12 +80,9 @@ module Parlour
         # We don't need to change anything! We only merge identical includes
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this code.
-      #
-      # @return [String]
-      def describe
-        "Include (#{@type})"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [{type: type}] # avoid quotes
       end
     end
   end

data/lib/parlour/rbs_generator/interface_namespace.rb

@@ -5,6 +5,8 @@ module Parlour
     class InterfaceNamespace < Namespace
       extend T::Sig
 
+      Child = type_member {{ fixed: RbsObject }}
+
       sig do
         override.params(
           indent_level: Integer,
@@ -23,11 +25,9 @@ module Parlour
         lines << options.indented(indent_level, "end")
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this interface.
-      # @return [String]
-      def describe
-        "Interface #{name} - #{children.length}"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [:children]
       end
     end
   end

data/lib/parlour/rbs_generator/method.rb

@@ -133,13 +133,12 @@ module Parlour
         # TODO: merge signatures of different definitions
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this method.
-      #
-      # @return [String]
-      def describe
-        # TODO: more info
-        "Method #{name} - #{signatures.length} signatures"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+          [
+            {signatures: "(#{signatures.map(&:describe_in_method).join(", ")})"},
+            :class_method,
+          ]
       end
     end
   end

data/lib/parlour/rbs_generator/method_signature.rb

@@ -99,6 +99,19 @@ module Parlour
 
         generated_params
       end
+
+      sig { returns(String) }
+      def describe_in_method
+        # RBS is terse enough that just describing using the RBS is probably
+        # fine. (Unfortunately, this doesn't allow any differentiation between 
+        # string types and Parlour::Types types.)
+        # (#describe is supposed to be one line, but this will break if you
+        # have than 10000 parameters. Honestly, if you do have more than 10000
+        # parameters, you deserve this...)
+        generate_rbs(Parlour::Options.new(
+          break_params: 10000, tab_size: 2, sort_namespaces: false
+        )).join("\n")
+      end
     end
   end
 end

data/lib/parlour/rbs_generator/module_namespace.rb

@@ -5,6 +5,8 @@ module Parlour
     class ModuleNamespace < Namespace
       extend T::Sig
 
+      Child = type_member {{ fixed: RbsObject }}
+
       sig do
         override.params(
           indent_level: Integer,
@@ -23,12 +25,9 @@ module Parlour
         lines << options.indented(indent_level, "end")
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this module.
-      # @return [String]
-      def describe
-        "Module #{name} - #{children.length} " +
-          "children, #{includes.length} includes, #{extends.length} extends"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [:children]
       end
     end
   end

data/lib/parlour/rbs_generator/namespace.rb

@@ -5,6 +5,7 @@ module Parlour
     # {RbsGenerator#root}.
     class Namespace < RbsObject
       extend T::Sig
+      extend T::Generic
 
       sig do
         override.overridable.params(
@@ -45,11 +46,14 @@ module Parlour
         yield_self(&block) if block
       end
 
-      sig { returns(T::Array[RbsObject]) }
+      sig { override.returns(T::Array[RbsObject]).checked(:never) }
       # The child {RbsObject} instances inside this namespace.
       # @return [Array<RbsObject>]
       attr_reader :children
 
+      include Mixin::Searchable
+      Child = type_member {{ fixed: RbsObject }}
+
       sig { returns(T::Array[RbsGenerator::Extend]) }
       # The {RbsGenerator::Extend} objects from {children}.
       # @return [Array<RbsGenerator::Extend>]
@@ -517,13 +521,9 @@ module Parlour
         end
       end
 
-      sig { override.overridable.returns(String) }
-      # Returns a human-readable brief string description of this namespace.
-      #
-      # @return [String]
-      def describe
-        "Namespace #{name} - #{children.length} children, #{includes.length} " +
-          "includes, #{extends.length} extends, #{constants.length} constants"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [:children]
       end
 
       private

data/lib/parlour/rbs_generator/rbs_object.rb

@@ -68,11 +68,6 @@ module Parlour
       # @param others [Array<RbsGenerator::RbsObject>] An array of other {RbsObject} instances.
       # @return [void]
       def merge_into_self(others); end
-
-      sig { overridable.override.returns(String) }
-      def describe
-        'RBS object'
-      end  
     end
   end
 end

data/lib/parlour/rbs_generator/type_alias.rb

@@ -84,12 +84,9 @@ module Parlour
         # We don't need to change anything! We only merge identical type alias
       end
 
-      sig { override.returns(String) }
-      # Returns a human-readable brief string description of this code.
-      #
-      # @return [String]
-      def describe
-        "Type Alias (#{name} = #{type})"
+      sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+      def describe_attrs
+        [{type: type}] # avoid quotes
       end
     end
   end

data/lib/parlour/type_loader.rb

@@ -60,7 +60,12 @@ module Parlour
         chdir: root
       )
 
-      file_table_hash = JSON.parse(T.must(stdout.read))
+      stdout = T.must(stdout.read)
+      if stdout == ''
+        raise 'unable to get Sorbet file table; the project may be empty or not have Sorbet initialised'
+      end
+
+      file_table_hash = JSON.parse(stdout)
       file_table_entries = file_table_hash['files']
 
       namespaces = T.let([], T::Array[Parlour::RbiGenerator::Namespace])

data/lib/parlour/type_parser.rb

@@ -361,8 +361,8 @@ module Parlour
         #   (block (send (const nil :T) :type_alias) (args) (type_to_alias))
         if body.type == :block &&
           body.to_a[0].type == :send &&
-          body.to_a[0].to_a[0].type == :const &&
-          body.to_a[0].to_a[0].to_a == [nil, :T] &&
+          body.to_a[0].to_a[0]&.type == :const &&
+          body.to_a[0].to_a[0]&.to_a == [nil, :T] &&
           body.to_a[0].to_a[1] == :type_alias
 
           [Parlour::RbiGenerator::TypeAlias.new(

data/lib/parlour/typed_object.rb

@@ -20,7 +20,7 @@ module Parlour
     # @return [Plugin, nil]
     attr_reader :generated_by
 
-    sig { returns(String) }
+    sig { returns(String).checked(:never) }
     # The name of this object.
     # @return [String]
     attr_reader :name
@@ -57,16 +57,101 @@ module Parlour
 
     alias_method :add_comments, :add_comment
 
-    sig { abstract.returns(String) }
+    sig { 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
+    def describe
+      if is_a?(RbiGenerator::RbiObject)
+        type_system = 'RBI'
+      elsif is_a?(RbsGenerator::RbsObject)
+        type_system = 'RBS'
+      else
+        raise 'unknown type system'
+      end
+
+      attr_strings = describe_attrs.map do |a|
+        case a
+        when Symbol
+          key = a
+          value = send(a)
+
+          case value
+          when Array, Hash
+            value = value.length
+            next nil if value == 0
+          when String
+            value = value.inspect
+          when Parlour::Types::Type
+            value = value.describe
+          when true
+            next key
+          when false
+            next nil
+          end
+        when Hash
+          raise 'describe_attrs Hash must have one key' unless a.length == 1
+
+          key = a.keys[0]
+          value = a.values[0]
+        end
+
+        "#{key}=#{value}"
+      end.compact
+
+      class_name = T.must(self.class.name).split('::').last
+      if attr_strings.empty?
+        "<#{type_system}:#{class_name}:#{name}>"
+      else
+        "<#{type_system}:#{class_name}:#{name} #{attr_strings.join(" ")}>"
+      end
+    end
+
+    sig { params(tree: T.nilable(Debugging::Tree)).returns(String) }
+    # Returns a human-readable multi-line string description of this object and
+    # its children recursively.
+    #
+    # @return [String]
+    def describe_tree(tree: nil)
+      if tree.nil?
+        tree = Debugging::Tree.new
+        result = "#{describe}\n"
+      else
+        result = ""
+      end
+
+      if is_a?(RbiGenerator::Namespace) || is_a?(RbsGenerator::Namespace)
+        children.each do |child|
+          result += "#{tree.begin(child.describe)}\n"
+          result += child.describe_tree(tree: tree)
+          tree.indent!(-1)
+        end
+      else
+        "#{describe}\n"
+      end
+
+      result
+    end
+
+    alias inspect describe
+    alias to_s describe
     
     protected
 
+    sig { abstract.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
+    # The attributes for an instance of this object which should be included in
+    # its string form generated by +#describe+.
+    # For each element in the returned array:
+    #   - If it is a symbol, this symbol will be called on +self+ and the
+    #     returned object will be dynamically converted into a string.
+    #   - If it is a hash, it must be of the format { Symbol => String }. The
+    #     given string will be used instead of calling the symbol.
+    #
+    # @abstract
+    # @return [<Symbol, String>]
+    def describe_attrs; end
+
     sig do
       params(
         indent_level: Integer,
@@ -84,4 +169,4 @@ module Parlour
         : []
     end
   end
-end
+end

data/lib/parlour/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 module Parlour
   # The library version.
-  VERSION = '5.0.0'
+  VERSION = '7.0.0'
 end

data/lib/parlour.rb

@@ -14,6 +14,8 @@ require 'parlour/types'
 require 'parlour/options'
 require 'parlour/typed_object'
 require 'parlour/generator'
+require 'parlour/mixin/searchable'
+
 require 'parlour/rbi_generator/parameter'
 require 'parlour/rbi_generator/rbi_object'
 require 'parlour/rbi_generator/type_alias'

data/parlour.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|sorbet)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|sorbet|rbi)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sorbet"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
 end