parlour 5.0.0.beta.3 → 6.0.0

data/lib/parlour/rbi_generator/parameter.rb

@@ -39,7 +39,7 @@ module Parlour
         @name = name
 
         prefix = /^(\*\*|\*|\&)?/.match(name)&.captures&.first || ''
-        @kind = PREFIXES.rassoc(prefix).first
+        @kind = T.must(PREFIXES.rassoc(prefix)).first
 
         @kind = :keyword if kind == :normal && name.end_with?(':')
 
@@ -123,12 +123,12 @@ module Parlour
       end
 
       # A mapping of {kind} values to the characteristic prefixes each kind has.
-      PREFIXES = {
+      PREFIXES = T.let({
         normal: '',
         splat: '*',
         double_splat: '**',
         block: '&'
-      }.freeze
+      }.freeze, T::Hash[Symbol, String])
 
       sig { void }
       def generalize_from_rbi!

data/lib/parlour/rbi_generator/struct_class_namespace.rb

@@ -11,6 +11,7 @@ module Parlour
           generator: Generator,
           name: String,
           final: T::Boolean,
+          sealed: T::Boolean,
           props: T::Array[StructProp],
           abstract: T::Boolean,
           block: T.nilable(T.proc.params(x: StructClassNamespace).void)
@@ -22,12 +23,13 @@ module Parlour
       # @param generator [RbiGenerator] The current RbiGenerator.
       # @param name [String] The name of this class.
       # @param final [Boolean] Whether this namespace is final.
+      # @param sealed [Boolean] Whether this namespace is sealed.
       # @param props [Array<StructProp>] The props of the struct.
       # @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, final, props, abstract, &block)
-        super(generator, name, final, 'T::Struct', abstract, &block)
+      def initialize(generator, name, final, sealed, props, abstract, &block)
+        super(generator, name, final, sealed, 'T::Struct', abstract, &block)
         @props = props
       end
 

data/lib/parlour/rbi_generator/struct_prop.rb

@@ -112,9 +112,9 @@ module Parlour
       attr_reader :redaction
 
       # The optional properties available on instances of this class.
-      EXTRA_PROPERTIES = %i{
+      EXTRA_PROPERTIES = T.let(%i{
         optional enum dont_store foreign default factory immutable array override redaction
-      }
+      }, T::Array[Symbol])
 
       sig { returns(String) }
       # Returns the +prop+ call required to create this property.

data/lib/parlour/rbi_generator/type_alias.rb

@@ -21,7 +21,7 @@ module Parlour
         yield_self(&block) if block
       end
 
-      # @return [String] The type to alias to.
+      # @return [Types::TypeLike] The type to alias to.
       sig { returns(Types::TypeLike) }
       attr_reader :type
 

data/lib/parlour/rbs_generator/method.rb

@@ -89,7 +89,7 @@ module Parlour
 
           # Merge the first signature line, and indent & concat the rest
           first_line, *rest_lines = *partial_sig_lines
-          this_sig_lines[0] += first_line
+          this_sig_lines[0] = T.unsafe(this_sig_lines[0]) + first_line
           rest_lines&.each do |line|
             this_sig_lines << ' ' * definition.length + options.indented(indent_level, line)
           end

data/lib/parlour/type_parser.rb

@@ -158,6 +158,7 @@ module Parlour
 
         name, superclass, body = *node
         final = body_has_modifier?(body, :final!)
+        sealed = body_has_modifier?(body, :sealed!)
         abstract = body_has_modifier?(body, :abstract!)
         includes, extends = body ? body_includes_and_extends(body) : [[], []]
 
@@ -170,6 +171,7 @@ module Parlour
             generator,
             n.to_s,
             false,
+            false,
           )
           target.children << new_obj if target
           target = new_obj
@@ -233,6 +235,7 @@ module Parlour
             generator,
             this_name.to_s,
             final,
+            sealed,
             props,
             abstract,
           )
@@ -256,6 +259,7 @@ module Parlour
             generator,
             this_name.to_s,
             final,
+            sealed,
             enums,
             abstract,
           )
@@ -264,6 +268,7 @@ module Parlour
             generator,
             this_name.to_s,
             final,
+            sealed,
             node_to_s(superclass),
             abstract,
           )
@@ -275,7 +280,7 @@ module Parlour
 
         if target
           target.children << final_obj
-          [top_level]
+          [T.must(top_level)]
         else
           [final_obj]
         end
@@ -283,7 +288,9 @@ module Parlour
         parse_err 'cannot declare modules in an eigenclass', node if is_within_eigenclass
 
         name, body = *node
+        abstract = body_has_modifier?(body, :abstract!)
         final = body_has_modifier?(body, :final!)
+        sealed = body_has_modifier?(body, :sealed!)
         interface = body_has_modifier?(body, :interface!)
         includes, extends = body ? body_includes_and_extends(body) : [[], []]
 
@@ -296,6 +303,7 @@ module Parlour
             generator,
             n.to_s,
             false,
+            false,
           )
           target.children << new_obj if target
           target = new_obj
@@ -306,7 +314,9 @@ module Parlour
           generator,
           this_name.to_s,
           final,
+          sealed,
           interface,
+          abstract,
         ) do |m|
           m.children.concat(parse_path_to_object(path.child(1))) if body
           m.create_includes(includes)
@@ -315,7 +325,7 @@ module Parlour
 
         if target
           target.children << final_obj
-          [top_level]
+          [T.must(top_level)]
         else
           [final_obj]
         end
@@ -345,11 +355,28 @@ module Parlour
         end.flatten
       when :casgn
         _, name, body = *node
-        [Parlour::RbiGenerator::Constant.new(
-          generator,
-          name: T.must(name).to_s,
-          value: T.must(node_to_s(body)),
-        )]
+
+        # Determine whether this is a constant or a type alias
+        # A type alias looks like:
+        #   (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[1] == :type_alias
+
+          [Parlour::RbiGenerator::TypeAlias.new(
+            generator,
+            name: T.must(name).to_s,
+            type: T.must(node_to_s(body.to_a[2])),
+          )]
+        else
+          [Parlour::RbiGenerator::Constant.new(
+            generator,
+            name: T.must(name).to_s,
+            value: T.must(node_to_s(body)),
+          )]
+        end
       else
         if unknown_node_errors
           parse_err "don't understand node type #{node.type}", node
@@ -704,7 +731,7 @@ module Parlour
     end
 
     sig { params(node: Parser::AST::Node).returns(Types::Type) }
-    # Given an AST node representing an RBI type (such as 'T::Array[String]'),  
+    # Given an AST node representing an RBI type (such as 'T::Array[String]'),
     # parses it into a generic type.
     #
     # @param [Parser::AST::Node] node
@@ -719,9 +746,9 @@ module Parlour
           names = constant_names(target)
           known_single_element_collections = [:Array, :Set, :Range, :Enumerator, :Enumerable]
 
-          if names.length == 2 && names[0] == :T && 
+          if names.length == 2 && names[0] == :T &&
             known_single_element_collections.include?(names[1])
-            
+
             parse_err "no type in T::#{names[1]}[...]", node if args.nil? || args.empty?
             parse_err "too many types in T::#{names[1]}[...]", node unless args.length == 1
             return T.must(Types.const_get(T.must(names[1]))).new(parse_node_to_type(T.must(args.first)))
@@ -732,9 +759,17 @@ module Parlour
               parse_node_to_type(args[0]), parse_node_to_type(args[1])
             )
           else
-            # TODO
-            warning "user-defined generic types not implemented, treating #{names.last} as untyped", node
-            return Types::Untyped.new
+            type = names.join('::')
+            if args.nil?
+              parse_err(
+                "user defined generic '#{type}' requires at least one type parameter",
+                node
+              )
+            end
+            return Types::Generic.new(
+              type,
+              args.map { |arg| parse_node_to_type(arg) }
+            )
           end
         end
 
@@ -743,7 +778,7 @@ module Parlour
         # something pretty cursed with procs to break this
         # This checks for (send (send (send (const nil :T) :proc) ...) ...)
         # That's the right amount of nesting for T.proc.params(...).returns(...)
-        if node.to_a[0].type == :send && 
+        if node.to_a[0].type == :send &&
           node.to_a[0].to_a[0].type == :send &&
           node.to_a[0].to_a[0].to_a[1] == :proc &&
           node.to_a[0].to_a[0].to_a[0].type == :const &&
@@ -780,7 +815,7 @@ module Parlour
         # The other options for a valid call are all "T.something" methods
         parse_err "unexpected call #{node_to_s(node).inspect} in type", node \
           unless target.type == :const && target.to_a == [nil, :T]
-            
+
         case message
         when :nilable
           parse_err 'no argument to T.nilable', node if args.nil? || args.empty?
@@ -811,7 +846,7 @@ module Parlour
         else
           warning "unknown method T.#{message}, treating as untyped", node
           Types::Untyped.new
-        end 
+        end
       when :const
         # Special case: T::Boolean
         if constant_names(node) == [:T, :Boolean]

data/lib/parlour/types.rb

@@ -196,6 +196,45 @@ module Parlour
       end
     end
 
+    # A user-defined generic class with an arbitrary number of type
+    # parameters. This class assumes at least one type_param is
+    # provided, otherwise output will have empty type param lists.
+    class Generic < Type
+      sig { params(type: TypeLike, type_params: T::Array[TypeLike]).void }
+      def initialize(type, type_params)
+        @type = to_type(type)
+        @type_params = type_params.map { |p| to_type(p) }
+      end
+
+      sig { params(other: Object).returns(T::Boolean) }
+      def ==(other)
+        self.class === other &&
+          type == other.type &&
+          type_params == other.type_params
+      end
+
+      sig { returns(Type) }
+      attr_reader :type
+
+      sig { returns(T::Array[Type]) }
+      attr_reader :type_params
+
+      sig { override.returns(String) }
+      def generate_rbi
+        "#{type.generate_rbi}[#{type_params.map(&:generate_rbi).join(', ')}]"
+      end
+
+      sig { override.returns(String) }
+      def generate_rbs
+        "#{type.generate_rbs}[#{type_params.map(&:generate_rbs).join(', ')}]"
+      end
+
+      sig { override.returns(String) }
+      def describe
+        "#{type.describe}<#{type_params.map(&:describe).join(', ')}>"
+      end
+    end
+
     class SingleElementCollection < Type
       abstract!
 
@@ -217,7 +256,7 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs
-        "#{collection_name}[#{element.generate_rbs}]"
+        "::#{collection_name}[#{element.generate_rbs}]"
       end
 
       sig { override.returns(String) }
@@ -317,7 +356,7 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs
-        "Hash[#{key.generate_rbs}, #{value.generate_rbs}]"
+        "::Hash[#{key.generate_rbs}, #{value.generate_rbs}]"
       end
 
       sig { override.returns(String) }
@@ -436,9 +475,9 @@ module Parlour
       def describe
         "self"
       end
-    end    
+    end
 
-    # The explicit lack of a type. 
+    # The explicit lack of a type.
     class Untyped < Type
       sig { params(other: Object).returns(T::Boolean) }
       def ==(other)
@@ -487,9 +526,9 @@ module Parlour
         def ==(other)
           Parameter === other && name == other.name && type == other.type &&
             default == other.default
-        end  
+        end
       end
-      
+
       sig { params(parameters: T::Array[Parameter], return_type: T.nilable(TypeLike)).void }
       def initialize(parameters, return_type)
         @parameters = parameters
@@ -536,4 +575,4 @@ module Parlour
     end
   end
 end
-        
+

data/lib/parlour/version.rb

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta.3
+  version: 6.0.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - hello@aaronc.cc
@@ -146,16 +160,17 @@ extra_rdoc_files: []
 files:
 - ".github/ISSUE_TEMPLATE/bug-report.md"
 - ".github/ISSUE_TEMPLATE/feature-request.md"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".parlour"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- ci/check_rbi.sh
 - exe/parlour
 - lib/parlour.rb
 - lib/parlour/conflict_resolver.rb
@@ -208,7 +223,6 @@ files:
 - lib/parlour/version.rb
 - parlour.gemspec
 - plugin_examples/foobar_plugin.rb
-- rbi/parlour.rbi
 homepage: https://github.com/AaronC81/parlour
 licenses:
 - MIT
@@ -224,11 +238,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.0.rc.1
 signing_key:
 specification_version: 4
 summary: A type information generator, merger and parser for Sorbet and Ruby 3/Steep