parlour 5.0.0.beta.1 → 5.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8117de48194856013f343430fd893e1b8bc75e51fc8b8811e70bc89a3f9989aa
-  data.tar.gz: bc980c3cb70a33c60fc92c23f10f2d844da076161a65e2c24fde49e24d4aceb9
+  metadata.gz: 67507b0ea29af60c22d4e326220ea362441969c56c06d357767660356ff39b6c
+  data.tar.gz: 1f2cc037d17d4a3bfabc86b34b937d9a7fc9986af0302eb950fe310146944739
 SHA512:
-  metadata.gz: 6bcf142fd126d52f38d2d0d5f597e85d7a4274c321b927230ce100aae9d3941bd6abb7e2cf35ccf597c2b5eaf71121126d5bd85c814d63cdece0e479536740c3
-  data.tar.gz: 5af1d6099e12dff2105dca26c4a6db90bba1190018ab7e514dd413e272e3942ef3b608666e91e5fa26b6bdc23f2d886e41ab1d1655085e36ca5f0b94b461448f
+  metadata.gz: 446a15c1a26e799b3d407ef0e1e2c02b441a559da38a327cda3d2110ea6013825beb6870c14a42531425bb6b83a8595d1298cfe70d9bbd87cc27ebff9e397985
+  data.tar.gz: 8b4df35779cd3b6c1129811a271788a303bf1c57fe271bebea135a48c06dafbb1ecead10a9e3da3ae36b4d17953848767a0a546b2a7de00fc24b3ff02ec71e04

data/CHANGELOG.md

@@ -3,6 +3,17 @@ 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/).
 
+## [5.0.0.beta.2] - 2020-09-14
+### Added
+- Added `Types::Type#describe` for simple text descriptions of types
+- Added `Types::Self` for RBI's `T.self_type` or RBS' `self`
+
+### Fixed
+- Fixed `RbiGenerator::Namespace#create_method`'s `returns:` kwarg only
+  accepting String types
+- Fixed lack of spacing between argument lists and blocks in RBS
+- Fixed RBS attributes not having comments
+
 ## [5.0.0.beta.1] - 2020-09-13
 ### Added
 - Added RBS generation support! This includes:

data/lib/parlour/rbi_generator/namespace.rb

@@ -272,7 +272,7 @@ module Parlour
           name: String,
           parameters: T.nilable(T::Array[Parameter]),
           return_type: T.nilable(Types::TypeLike),
-          returns: T.nilable(String),
+          returns: T.nilable(Types::TypeLike),
           abstract: T::Boolean,
           implementation: T::Boolean,
           override: T::Boolean,

data/lib/parlour/rbs_generator/attribute.rb

@@ -60,7 +60,7 @@ module Parlour
       # @param options [Options] The formatting options to use.
       # @return [Array<String>] The RBS lines, formatted as specified.
       def generate_rbs(indent_level, options)
-        [options.indented(
+        generate_comments(indent_level, options) + [options.indented(
           indent_level,
           "attr_#{kind} #{name}: #{String === @type ? @type : @type.generate_rbs}"
         )]

data/lib/parlour/rbs_generator/method_signature.rb

@@ -94,7 +94,7 @@ module Parlour
         }" + T.must(generated_params[0])
 
         generated_params[-1] = T.must(generated_params[-1]) + "#{
-          (block_type && block_type != 'untyped') ? block_type.first : '' # TODO: doesn't support multi-line block types
+          (block_type && block_type.first != 'untyped') ? " #{block_type.first}" : '' # TODO: doesn't support multi-line block types
         } -> #{rbs_return_type || 'void'}"
 
         generated_params

data/lib/parlour/types.rb

@@ -32,6 +32,13 @@ module Parlour
       def to_type(type_like)
         Type.to_type(type_like)
       end
+
+      def hash
+        [self.class, *instance_variables.map { |x| instance_variable_get(x).hash }].hash
+      end
+
+      sig { abstract.returns(String) }
+      def describe; end
     end
 
     # A basic type as a raw string.
@@ -58,6 +65,11 @@ module Parlour
       def generate_rbs
         str
       end
+
+      sig { override.returns(String) }
+      def describe
+        str
+      end
     end
 
     # A type which can be either the wrapped type, or nil.
@@ -84,6 +96,11 @@ module Parlour
       def generate_rbs
         "#{type.generate_rbs}?"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "Nilable<#{type.describe}>"
+      end
     end
 
     # A type which is (at least) one of the wrapped types.
@@ -110,6 +127,11 @@ module Parlour
       def generate_rbs
         "(#{types.map(&:generate_rbs).join(' | ')})"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "Union<#{types.map(&:describe).join(', ')}>"
+      end
     end
 
     # A type which matches all of the wrapped types.
@@ -136,6 +158,11 @@ module Parlour
       def generate_rbs
         "(#{types.map(&:generate_rbs).join(' & ')})"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "Intersection<#{types.map(&:describe).join(', ')}>"
+      end
     end
 
     # A fixed-length array of items, each with a known type.
@@ -162,6 +189,11 @@ module Parlour
       def generate_rbs
         "[#{types.map(&:generate_rbs).join(', ')}]"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "[#{types.map(&:describe).join(', ')}]"
+      end
     end
 
     class SingleElementCollection < Type
@@ -187,6 +219,11 @@ module Parlour
       def generate_rbs
         "#{collection_name}[#{element.generate_rbs}]"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "#{collection_name}<#{element.describe}>"
+      end
     end
 
     # An array with known element types.
@@ -282,6 +319,11 @@ module Parlour
       def generate_rbs
         "Hash[#{key.generate_rbs}, #{value.generate_rbs}]"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "Hash<#{key.describe}, #{value.describe}>"
+      end
     end
 
     # A record/shape; a hash with a fixed set of keys with given types.
@@ -310,6 +352,11 @@ module Parlour
       def generate_rbs
         "{ #{keys_to_types.map { |k, v| "#{k}: #{v.generate_rbs}" }.join(', ')} }"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "{ #{keys_to_types.map { |k, v| "#{k}: #{v.describe}" }.join(', ')} }"
+      end
     end
 
     # A type which represents the class of a type, rather than an instance.
@@ -338,9 +385,14 @@ module Parlour
       def generate_rbs
         "singleton(#{type.generate_rbs})"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "Class<#{type.describe}>"
+      end
     end
 
-    # Generic type for a boolean.
+    # Type for a boolean.
     class Boolean < Type
       sig { params(other: Object).returns(T::Boolean) }
       def ==(other)
@@ -356,8 +408,36 @@ module Parlour
       def generate_rbs
         "bool"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "bool"
+      end
     end
 
+    # Type equivalent to the receiver.
+    class Self < Type
+      sig { params(other: Object).returns(T::Boolean) }
+      def ==(other)
+        Self === other
+      end
+
+      sig { override.returns(String) }
+      def generate_rbi
+        "T.self_type"
+      end
+
+      sig { override.returns(String) }
+      def generate_rbs
+        "self"
+      end
+
+      sig { override.returns(String) }
+      def describe
+        "self"
+      end
+    end    
+
     # The explicit lack of a type. 
     class Untyped < Type
       sig { params(other: Object).returns(T::Boolean) }
@@ -374,6 +454,11 @@ module Parlour
       def generate_rbs
         "untyped"
       end
+
+      sig { override.returns(String) }
+      def describe
+        "untyped"
+      end
     end
 
     # A type which can be called as a function.
@@ -439,6 +524,15 @@ module Parlour
         end
         "(#{rbs_params.map(&:to_rbs_param).join(', ')}) -> #{return_type&.generate_rbs || 'void'}"
       end
+
+      sig { override.returns(String) }
+      def describe
+        # For simplicity, use RBS with pre-described parameter types
+        rbs_params = parameters.map do |param|
+          RbsGenerator::Parameter.new(param.name, type: param.type.describe, required: param.default.nil?)
+        end
+        "(#{rbs_params.map(&:to_rbs_param).join(', ')}) -> #{return_type&.describe || 'void'}"
+      end
     end
   end
 end

data/lib/parlour/version.rb

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

data/rbi/parlour.rbi

@@ -3,7 +3,7 @@ module Kernel
 end
 
 module Parlour
-  VERSION = '5.0.0.beta.1'
+  VERSION = '5.0.0.beta.2'
 
   class ConflictResolver
     extend T::Sig
@@ -319,6 +319,12 @@ module Parlour
 
       sig { params(type_like: TypeLike).returns(Type) }
       def to_type(type_like); end
+
+      sig { returns(T.untyped) }
+      def hash; end
+
+      sig { abstract.returns(String) }
+      def describe; end
     end
 
     class Raw < Type
@@ -336,6 +342,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Nilable < Type
@@ -353,6 +362,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Union < Type
@@ -370,6 +382,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Intersection < Type
@@ -387,6 +402,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Tuple < Type
@@ -404,6 +422,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class SingleElementCollection < Type
@@ -423,6 +444,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Array < SingleElementCollection
@@ -483,6 +507,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Record < Type
@@ -500,6 +527,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Class < Type
@@ -517,6 +547,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Boolean < Type
@@ -528,6 +561,23 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
+    end
+
+    class Self < Type
+      sig { params(other: Object).returns(T::Boolean) }
+      def ==(other); end
+
+      sig { override.returns(String) }
+      def generate_rbi; end
+
+      sig { override.returns(String) }
+      def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Untyped < Type
@@ -539,6 +589,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
 
     class Proc < Type
@@ -578,6 +631,9 @@ module Parlour
 
       sig { override.returns(String) }
       def generate_rbs; end
+
+      sig { override.returns(String) }
+      def describe; end
     end
   end
 
@@ -1030,7 +1086,7 @@ module Parlour
           name: String,
           parameters: T.nilable(T::Array[Parameter]),
           return_type: T.nilable(Types::TypeLike),
-          returns: T.nilable(String),
+          returns: T.nilable(Types::TypeLike),
           abstract: T::Boolean,
           implementation: T::Boolean,
           override: T::Boolean,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta.1
+  version: 5.0.0.beta.2
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-13 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime