parlour 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e525051c1791bc175f8cbd109497f058e8708a60820683390e76c0f055ffca32
-  data.tar.gz: 68ff90fd52d6c2b252460b62402556ddee28ac246e7d16f16681e7dcd5e07337
+  metadata.gz: 12b7eca4df3f9c2609ae2f8cabbf07b73a26c66f596ce060aea6f9faec5a494d
+  data.tar.gz: 6ca3cf5d7d22d15fd3270adf78044b4aa8286808074c0e0c9b43b68ef4be0bdb
 SHA512:
-  metadata.gz: f677a46f79678ae034348c85e52fbe80ee231eadb9ab08544fef93970f7a3615d0edc79aabeaa6b0be47072394054896d8f09e4b93a11c69e8caa13f6e7a25d2
-  data.tar.gz: fa81cba64780ff57a8b147b6aeb5b6501f3fbc6bfbf877480f017ca4a0f8cd989992067416f5afc326293d2f83a4e1652957576a0425298d60a26ecea934660d
+  metadata.gz: d90cfc6922e9b4ccea622d31d4cdbfe422e6cd8292cdae12a1b2e70ee51bfd1d1779ae66b1b213c14806e3239306f92e149e2d280387127c66147f570d8e198d
+  data.tar.gz: a9f75203ac84c20e91dd24702c904b79741f1156b4975da43d3078423e316ecb534ae56261a4c949454175ee49ba4d5f44236dcadadcebb6368f00a30d52d937

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/).
 
+## [0.8.0] - 2019-09-14
+### Added
+- Methods can now have type parameters specified.
+
+### Changed
+- **Breaking change: The `implementation` qualifier is no longer genereated.**
+Following Sorbet merging `implementation` and `override` into just `override`,
+the `Method#implementation` and `Method#override` flags will now both generate 
+the `override` qualifier.
+- The Parlour codebase now uses `override` for both abstract implementation and
+superclass overriding to conform to this change.
+
 ## [0.7.0] - 2019-09-11
 ### Added
 - The strictness level can now be specified when generating an RBI, using an

data/lib/parlour/rbi_generator/arbitrary.rb

@@ -35,7 +35,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           indent_level: Integer,
           options: Options
         ).returns(T::Array[String])
@@ -50,7 +50,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).returns(T::Boolean)
       end
@@ -65,7 +65,7 @@ module Parlour
       end
 
       sig do 
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).void
       end

data/lib/parlour/rbi_generator/constant.rb

@@ -36,7 +36,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           indent_level: Integer,
           options: Options
         ).returns(T::Array[String])
@@ -51,7 +51,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).returns(T::Boolean)
       end
@@ -66,7 +66,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).void
       end
@@ -82,7 +82,7 @@ module Parlour
         # We don't need to change anything! We only merge identical constants
       end
 
-      sig { implementation.returns(String) }
+      sig { override.returns(String) }
       # Returns a human-readable brief string description of this code.
       #
       # @return [String]

data/lib/parlour/rbi_generator/extend.rb

@@ -29,7 +29,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           indent_level: Integer,
           options: Options
         ).returns(T::Array[String])
@@ -44,7 +44,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).returns(T::Boolean)
       end
@@ -59,7 +59,7 @@ module Parlour
       end
 
       sig do 
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).void
       end
@@ -75,7 +75,7 @@ module Parlour
         # We don't need to change anything! We only merge identical extends
       end
 
-      sig { implementation.returns(String) }
+      sig { override.returns(String) }
       # Returns a human-readable brief string description of this code.
       #
       # @return [String]

data/lib/parlour/rbi_generator/include.rb

@@ -29,7 +29,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           indent_level: Integer,
           options: Options
         ).returns(T::Array[String])
@@ -44,7 +44,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).returns(T::Boolean)
       end
@@ -59,7 +59,7 @@ module Parlour
       end
 
       sig do 
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).void
       end
@@ -75,7 +75,7 @@ module Parlour
         # We don't need to change anything! We only merge identical includes
       end
 
-      sig { implementation.returns(String) }
+      sig { override.returns(String) }
       # Returns a human-readable brief string description of this code.
       #
       # @return [String]

data/lib/parlour/rbi_generator/method.rb

@@ -16,6 +16,7 @@ module Parlour
           override: T::Boolean,
           overridable: T::Boolean,
           class_method: T::Boolean,
+          type_parameters: T.nilable(T::Array[Symbol]),
           block: T.nilable(T.proc.params(x: Method).void)
         ).void
       end
@@ -30,16 +31,17 @@ module Parlour
       # @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 abstract [Boolean] Whether this method is abstract.
-      # @param implementation [Boolean] Whether this method is an implementation of a
-      #   parent abstract method.
+      # @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.
+      #   method, or implementing a parent abstract method.
       # @param overridable [Boolean] Whether this method is overridable by subclasses.
       # @param class_method [Boolean] Whether this method is a class method; that is, it
       #   it is defined using +self.+.
+      # @param class_method [Array<Symbol>, nil] This method's type parameters.
       # @param block A block which the new instance yields itself to.
       # @return [void]
-      def initialize(generator, name, parameters, return_type = nil, abstract: false, implementation: false, override: false, overridable: false, class_method: false, &block)
+      def initialize(generator, name, parameters, return_type = nil, abstract: false, implementation: false, override: false, overridable: false, class_method: false, type_parameters: nil, &block)
         super(generator, name)
         @parameters = parameters
         @return_type = return_type
@@ -48,6 +50,7 @@ module Parlour
         @override = override
         @overridable = overridable
         @class_method = class_method
+        @type_parameters = type_parameters || []
         yield_self(&block) if block
       end
 
@@ -59,14 +62,15 @@ module Parlour
       # @return [Boolean]
       def ==(other)
         Method === other &&
-          name           == other.name && 
-          parameters     == other.parameters &&
-          return_type    == other.return_type &&
-          abstract       == other.abstract &&
-          implementation == other.implementation &&
-          override       == other.override &&
-          overridable    == other.overridable &&
-          class_method   == other.class_method
+          name            == other.name && 
+          parameters      == other.parameters &&
+          return_type     == other.return_type &&
+          abstract        == other.abstract &&
+          implementation  == other.implementation &&
+          override        == other.override &&
+          overridable     == other.overridable &&
+          class_method    == other.class_method &&
+          type_parameters == other.type_parameters
       end
 
       sig { returns(T::Array[Parameter]) }
@@ -87,11 +91,15 @@ module Parlour
 
       sig { returns(T::Boolean) }
       # Whether this method is an implementation of a parent abstract method.
+      # @deprecated Removed from Sorbet, as {#override} is used for both
+      #   abstract class implementations and superclass overrides. In Parlour,
+      #   this will now generate +override+.
       # @return [Boolean]
       attr_reader :implementation
 
       sig { returns(T::Boolean) }
-      # Whether this method is overriding a parent overridable method.
+      # Whether this method is overriding a parent overridable method, or
+      #   implementing a parent abstract method.
       # @return [Boolean]
       attr_reader :override
 
@@ -106,8 +114,13 @@ module Parlour
       # @return [Boolean]
       attr_reader :class_method
 
+      sig { returns(T::Array[Symbol]) }
+      # This method's type parameters.
+      # @return [Array<Symbol>]
+      attr_reader :type_parameters
+
       sig do
-        implementation.params(
+        override.params(
           indent_level: Integer,
           options: Options
         ).returns(T::Array[String])
@@ -142,7 +155,7 @@ module Parlour
 
           : [options.indented(
               indent_level,
-              "sig { #{qualifiers}#{
+              "sig { #{parameters.empty? ? qualifiers[0...-1] : qualifiers}#{
                 parameters.empty? ? '' : "params(#{sig_params.join(', ')})"
               }#{
                 qualifiers.empty? && parameters.empty? ? '' : '.'
@@ -154,7 +167,7 @@ module Parlour
       end
 
       sig do
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).returns(T::Boolean)
       end
@@ -169,7 +182,7 @@ module Parlour
       end
 
       sig do 
-        implementation.params(
+        override.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).void
       end
@@ -185,7 +198,7 @@ module Parlour
         # We don't need to change anything! We only merge identical methods
       end
 
-      sig { implementation.returns(String) }
+      sig { override.returns(String) }
       # Returns a human-readable brief string description of this method.
       #
       # @return [String]
@@ -228,9 +241,11 @@ module Parlour
       def qualifiers
         result = ''
         result += 'abstract.' if abstract
-        result += 'implementation.' if implementation
-        result += 'override.' if override
+        result += 'override.' if override || implementation
         result += 'overridable.' if overridable
+        result += "type_parameters(#{
+          type_parameters.map { |t| ":#{t}" }.join(', ')
+        })." if type_parameters.any?
         result
       end
     end

data/lib/parlour/rbi_generator/namespace.rb

@@ -7,7 +7,7 @@ module Parlour
       extend T::Sig
 
       sig do
-        implementation.overridable.params(
+        override.overridable.params(
           indent_level: Integer,
           options: Options
         ).returns(T::Array[String])
@@ -199,6 +199,7 @@ module Parlour
           override: T::Boolean,
           overridable: T::Boolean,
           class_method: T::Boolean,
+          type_parameters: T.nilable(T::Array[Symbol]),
           block: T.nilable(T.proc.params(x: Method).void)
         ).returns(Method)
       end
@@ -212,16 +213,17 @@ module Parlour
       #   +"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] Whether this method is an implementation of a
-      #   parent abstract method.
+      # @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.
+      #   method, or implementing a parent abstract method.
       # @param overridable [Boolean] Whether this method is overridable by subclasses.
       # @param class_method [Boolean] Whether this method is a class method; that is, it
       #   it is defined using +self.+.
+      # @param class_method [Array<Symbol>, nil] This method's type parameters.
       # @param block A block which the new instance yields itself to.
       # @return [Method]
-      def create_method(name, parameters: nil, return_type: nil, returns: nil, abstract: false, implementation: false, override: false, overridable: false, class_method: false, &block)
+      def create_method(name, parameters: nil, return_type: nil, returns: nil, abstract: false, implementation: false, override: false, overridable: false, class_method: false, type_parameters: nil, &block)
         parameters = parameters || []
         raise 'cannot specify both return_type: and returns:' if return_type && returns
         return_type ||= returns
@@ -235,6 +237,7 @@ module Parlour
           override: override,
           overridable: overridable,
           class_method: class_method,
+          type_parameters: type_parameters,
           &block
         )
         move_next_comments(new_method)
@@ -476,7 +479,7 @@ module Parlour
       end
 
       sig do
-        implementation.overridable.params(
+        override.overridable.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).returns(T::Boolean)
       end
@@ -493,7 +496,7 @@ module Parlour
       end
 
       sig do 
-        implementation.overridable.params(
+        override.overridable.params(
           others: T::Array[RbiGenerator::RbiObject]
         ).void
       end
@@ -511,7 +514,7 @@ module Parlour
         end
       end
 
-      sig { implementation.overridable.returns(String) }
+      sig { override.overridable.returns(String) }
       # Returns a human-readable brief string description of this namespace.
       #
       # @return [String]

data/lib/parlour/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime