parlour 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 382331994bebd14df33b96b084d725b0375fa84e0a3aa263e944bad22bb5ef3f
-  data.tar.gz: 33b9014173a85bc6dddec5aa3ad38cc7e23d869636694fbbe96d4e07c7e78886
+  metadata.gz: 889d6730ffefc764887706e5dadc4441e66cdf32e4567e809f7e634f511b7dfc
+  data.tar.gz: 9e9ab14b6618c209c8d194bf6e5557398689f0656247cac9561064dbcd541a6a
 SHA512:
-  metadata.gz: 6ecd35a473c689909a7ef3b84af799cfa718b1901929743676c557d95f6dd717b3c9cd60dcec1c4274ce1ecc4e69310aa3213505c6f3ef479cfa580ccb39f187
-  data.tar.gz: 7dddda7cb3a9d123e74f0ed218d62b17697f63451b7389d6d5c92bb4712d41b1cc920380eb8ee3b84c7916be5ad8c32c5d2bb0f3b46c7828acefa45fa0581683
+  metadata.gz: ea57b34b827ced92fdd1d28387217c0a5bc7027d94319cac6ffb238847a2820e9c164df86c9b2c43e60826cb1b362000c7c2bfc7f1f63b9b998959c70a3be377
+  data.tar.gz: fb10c8c783aea69e412d1a6eb67dd736f3db377168a21f8025e28fdb76acfc94ed20f1f7b9a17dafbac39ebcc2d36846b350d04c3e59882b546143df374b9f41

data/.travis.yml

@@ -12,6 +12,7 @@ rvm:
   - ruby-head
 matrix:
   allow_failures:
+    - rvm: 2.3
     - rvm: ruby-head
 
 jobs:

data/CHANGELOG.md

@@ -3,6 +3,18 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [2.1.0] - 2020-03-22
+### Added
+- Files can now be excluded from the `TypeLoader`.
+
+### Changed
+- A block argument in the definition but not in the signature no longer causes
+an error in the `TypeParser`.
+- Sorting of namespace children is now a stable sort.
+
+### Fixed
+- Type parameters are now parsed by the `TypeParser`.
+
 ## [2.0.0] - 2020-02-10
 ### Added
 - Parlour can now load types back out of RBI files or Ruby source files by

data/lib/parlour/rbi_generator/namespace.rb

@@ -247,13 +247,13 @@ module Parlour
       #
       # @param name [String] The name of this method. You should not specify +self.+ in
       #   this - use the +class_method+ parameter instead.
-      # @param parameters [Array<Parameter>] An array of {Parameter} instances representing this 
+      # @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 returns [String, nil] Same as return_type.
       # @param abstract [Boolean] Whether this method is abstract.
-      # @param implementation [Boolean] DEPRECATED: Whether this method is an 
+      # @param implementation [Boolean] DEPRECATED: Whether this method is an
       #   implementation of a parent abstract method.
       # @param override [Boolean] Whether this method is overriding a parent overridable
       #   method, or implementing a parent abstract method.
@@ -544,25 +544,25 @@ module Parlour
       # can be merged into each other, as they lack definitions for themselves,
       # so there is nothing to conflict. (This isn't the case for subclasses
       # such as {ClassNamespace}.)
-      # 
+      #
       # @param others [Array<RbiGenerator::RbiObject>] An array of other {Namespace} instances.
       # @return [true] Always true.
       def mergeable?(others)
         true
       end
 
-      sig do 
+      sig do
         override.overridable.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).void
       end
       # Given an array of {Namespace} instances, merges them into this one.
-      # All children, constants, extends and includes are copied into this 
+      # All children, constants, extends and includes are copied into this
       # instance.
       #
       # There may also be {RbiGenerator::Method} instances in the stream, which
       # are ignored.
-      # 
+      #
       # @param others [Array<RbiGenerator::RbiObject>] An array of other {Namespace} instances.
       # @return [void]
       def merge_into_self(others)
@@ -616,10 +616,19 @@ module Parlour
         end
 
         # Process singleton class attributes
-        class_attributes, remaining_children = \
-          (options.sort_namespaces ? children.sort_by(&:name) : children)
-          .partition { |child| child.is_a?(Attribute) && child.class_attribute }
-        
+        sorted_children = (
+          if options.sort_namespaces
+            # sort_by can be unstable (and is in current MRI).
+            # Use the this work around to preserve order for ties
+            children.sort_by.with_index { |child, i| [child.name, i] }
+          else
+            children
+          end
+        )
+        class_attributes, remaining_children = sorted_children.partition do |child|
+          child.is_a?(Attribute) && child.class_attribute
+        end
+
         if class_attributes.any?
           result << options.indented(indent_level, 'class << self')
 

data/lib/parlour/type_loader.rb

@@ -30,7 +30,7 @@ module Parlour
       load_source(File.read(filename), filename)
     end
   
-    sig { params(root: String).returns(RbiGenerator::Namespace) }
+    sig { params(root: String, exclusions: T::Array[String]).returns(RbiGenerator::Namespace) }
     # Loads an entire Sorbet project using Sorbet's file table, obeying any
     # "typed: ignore" sigils, into a tree of objects.
     #
@@ -39,8 +39,12 @@ module Parlour
     #
     # @param [String] root The root of the project; where the "sorbet" directory
     #   and "Gemfile" are located.
+    # @param [Array<String>] exclusions A list of files to exclude when loading
+    #   the project, relative to the given root.
     # @return [RbiGenerator::Namespace] The root of the object tree.
-    def self.load_project(root)
+    def self.load_project(root, exclusions: [])
+      expanded_exclusions = exclusions.map { |e| File.expand_path(e, root) }
+      
       stdin, stdout, stderr, wait_thr = T.unsafe(Open3).popen3(
         'bundle exec srb tc -p file-table-json',
         chdir: root
@@ -58,6 +62,9 @@ module Parlour
         next if rel_path.start_with?('./sorbet/rbi/hidden-definitions/')
         path = File.expand_path(rel_path, root)
 
+        # Skip this file if it was excluded
+        next if expanded_exclusions.include?(path)
+
         # There are some entries which are URLs to stdlib
         next unless File.exist?(path)
 

data/lib/parlour/type_parser.rb

@@ -107,7 +107,7 @@ module Parlour
     def self.from_source(filename, source)
       buffer = Parser::Source::Buffer.new(filename)
       buffer.source = source
-      
+
       TypeParser.new(Parser::CurrentRuby.new.parse(buffer))
     end
 
@@ -117,7 +117,7 @@ module Parlour
 
     sig { returns(T::Boolean) }
     # @return [Boolean] Whether to raise an error if a node of an unknown kind
-    #   is encountered. 
+    #   is encountered.
     attr_reader :unknown_node_errors
 
     # Parses the entire source file and returns the resulting root namespace.
@@ -134,7 +134,7 @@ module Parlour
     # represents and returns it, recursing to any child namespaces and parsing
     # any methods within.
     #
-    # If the node directly represents several nodes, such as being a 
+    # If the node directly represents several nodes, such as being a
     # (begin ...) node, they are all returned.
     #
     # @param [NodePath] path The path to the namespace definition. Do not pass
@@ -144,7 +144,7 @@ module Parlour
     sig { params(path: NodePath, is_within_eigenclass: T::Boolean).returns(T::Array[RbiGenerator::RbiObject]) }
     def parse_path_to_object(path, is_within_eigenclass: false)
       node = path.traverse(ast)
-      
+
       case node.type
       when :class
         parse_err 'cannot declare classes in an eigenclass', node if is_within_eigenclass
@@ -158,7 +158,7 @@ module Parlour
         *parent_names, this_name = constant_names(name)
         target = T.let(nil, T.nilable(RbiGenerator::Namespace))
         top_level = T.let(nil, T.nilable(RbiGenerator::Namespace))
-        parent_names.each do |n| 
+        parent_names.each do |n|
           new_obj = RbiGenerator::Namespace.new(
             DetachedRbiGenerator.new,
             n.to_s,
@@ -199,7 +199,7 @@ module Parlour
         *parent_names, this_name = constant_names(name)
         target = T.let(nil, T.nilable(RbiGenerator::Namespace))
         top_level = T.let(nil, T.nilable(RbiGenerator::Namespace))
-        parent_names.each do |n| 
+        parent_names.each do |n|
           new_obj = RbiGenerator::Namespace.new(
             DetachedRbiGenerator.new,
             n.to_s,
@@ -236,7 +236,7 @@ module Parlour
       when :def, :defs
         # TODO: Support for defs without sigs
         #   If so, we need some kind of state machine to determine whether
-        #   they've already been dealt with by the "when :send" clause and 
+        #   they've already been dealt with by the "when :send" clause and
         #   #parse_sig_into_methods.
         #   If not, just ignore this.
         []
@@ -246,7 +246,7 @@ module Parlour
       when :begin
         # Just map over all the things
         node.to_a.length.times.map do |c|
-          parse_path_to_object(path.child(c), is_within_eigenclass: is_within_eigenclass) 
+          parse_path_to_object(path.child(c), is_within_eigenclass: is_within_eigenclass)
         end.flatten
       else
         if unknown_node_errors
@@ -259,6 +259,7 @@ module Parlour
 
     # A parsed sig, not associated with a method.
     class IntermediateSig < T::Struct
+      prop :type_parameters, T.nilable(T::Array[Symbol])
       prop :overridable, T::Boolean
       prop :override, T::Boolean
       prop :abstract, T::Boolean
@@ -318,7 +319,18 @@ module Parlour
           arg.to_a
         end
 
+      # Find type parameters if they were used
+      type_parameters = sig_chain
+        .find { |(n, _)| n == :type_parameters }
+        &.then do |(_, a)|
+          a.map do |arg|
+            parse_err 'type parameter must be a symbol', arg if arg.type != :sym
+            arg.to_a[0]
+          end
+        end
+
       IntermediateSig.new(
+        type_parameters: type_parameters,
         overridable: overridable,
         override: override,
         abstract: abstract,
@@ -370,7 +382,7 @@ module Parlour
             || target != nil
 
         parse_err 'typed attribute should have at least one name', def_node if parameters&.length == 0
-        
+
         kind = :attr
         attr_direction = method_name.to_s.gsub('attr_', '').to_sym
         def_names = T.must(parameters).map { |param| param.to_a[0].to_s }
@@ -389,6 +401,13 @@ module Parlour
       return_type = this_sig.return_type
 
       if kind == :def
+        # Sorbet allows a trailing blockarg that's not in the sig
+        if params &&
+           def_params.length == params.length + 1 &&
+           def_params[-1].type == :blockarg
+          def_params = def_params[0...-1]
+        end
+
         parse_err 'mismatching number of arguments in sig and def', sig_block_node \
           if params && def_params.length != params.length
 
@@ -399,6 +418,7 @@ module Parlour
         parameters = params \
           ? zip_by(params, ->x{ x.to_a[0].to_a[0] }, def_params, ->x{ x.to_a[0] })
             .map do |sig_arg, def_param|
+
               arg_name = def_param.to_a[0]
 
               # TODO: anonymous restarg
@@ -422,6 +442,7 @@ module Parlour
             def_name,
             parameters,
             return_type,
+            type_parameters: this_sig.type_parameters,
             override: this_sig.override,
             overridable: this_sig.overridable,
             abstract: this_sig.abstract,
@@ -437,7 +458,7 @@ module Parlour
 
           parse_err "attr_#{attr_direction} sig should have non-void return", sig_block_node \
             unless return_type
-            
+
           attr_type = return_type
         when :writer
           # These are special and can only have one name
@@ -476,7 +497,7 @@ module Parlour
     # A::B::C), converts that node into an array of the constant names which
     # are accessed. For example, A::B::C would become [:A, :B, :C].
     #
-    # @param [Parser::AST::Node, nil] node The node to convert. This must 
+    # @param [Parser::AST::Node, nil] node The node to convert. This must
     #   consist only of nested (:const) nodes.
     # @return [Array<Symbol>] The chain of constant names.
     def constant_names(node)
@@ -524,13 +545,13 @@ module Parlour
     def body_has_modifier?(node, modifier)
       return false unless node
 
-      (node.type == :send && node.to_a == [nil, modifier]) || 
+      (node.type == :send && node.to_a == [nil, modifier]) ||
         (node.type == :begin &&
           node.to_a.any? { |c| c.type == :send && c.to_a == [nil, modifier] })
     end
 
     sig { params(node: Parser::AST::Node).returns([T::Array[String], T::Array[String]]) }
-    # Given an AST node representing the body of a class or module, returns two 
+    # Given an AST node representing the body of a class or module, returns two
     # arrays of the includes and extends contained within the body.
     #
     # @param [Parser::AST::Node] node The body of the namespace.
@@ -568,7 +589,7 @@ module Parlour
       raise ParseError.new(buffer, range), desc
     end
 
-    sig do 
+    sig do
       type_parameters(:A, :B)
         .params(
           a: T::Array[T.type_parameter(:A)],
@@ -580,7 +601,7 @@ module Parlour
     end
     # Given two arrays and functions to get a key for each item in the two
     # arrays, joins the two arrays into one array of pairs by that key.
-    # 
+    #
     # The arrays should both be the same length, and the key functions should
     # never return duplicate keys for two different items.
     #
@@ -588,7 +609,7 @@ module Parlour
     # @param [A -> Any] fa A function to obtain a key for any element in the
     #   first array.
     # @param [Array<B>] b The second array.
-    # @param [B -> Any] fb A function to obtain a key for any element in the 
+    # @param [B -> Any] fb A function to obtain a key for any element in the
     #   second array.
     # @return [Array<(A, B)>] An array of pairs, where the left of the pair is
     #   an element from A and the right is the element from B with the
@@ -606,4 +627,4 @@ module Parlour
       end
     end
   end
-end
+end

data/lib/parlour/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An RBI generator, merger and parser for Sorbet