parlour 9.0.0 → 9.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8988bf8b6435625031d284916803461e688cc3b28a755da9918cd3d83189f260
-  data.tar.gz: ff851e34b9f7a85fdfb11db892a0d7ef692337157125ad0bab14856e7e67ced2
+  metadata.gz: 906222c4fcb94c3f3596055c6b1468b1eeea54ef5931632a2645f14bf9742bfc
+  data.tar.gz: 609ec24f2ff46cec34d42def81ef5149e550c7f4bf2297fb0a909699e37b0e6c
 SHA512:
-  metadata.gz: 2e173ea6f2d50139c1fbd143d2eedafc1e7ed8eb9c757b4f1cc177033c08676b9feca6c3f5bbf04a37e3a41b51abb0d52414aeab5957f42649d21a41d471bcb3
-  data.tar.gz: a17dbc4f7731d531b3603e2f57cab06636ded32fbe187902e930c786ba263d2be4405ad3de92c7e286f6a06c17c1968230d3e2f0ec26d1d7ba24242623a6bbea
+  metadata.gz: e0088a07cdaa2bdd29111122b15c4631e7b50ffc909bfb001d043943ddb9eb7ced94ee330e87256a418aa81f11c737daf3b2eee121946c7b5393d4e990b2fcd8
+  data.tar.gz: cbdac77bdc86e9037456b98394ea0127214f049e6fe01bae8117eaa3d80eaad1fcfbbf96586a86a10fbccc236b1125fd2ee46bd7d7c950f64bc5ea4af5bff146

data/.github/workflows/ruby.yml

@@ -37,14 +37,16 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: 3.0
     - name: Install dependencies
       run: bundle install
     - name: Build documentation
       run: bundle exec yard
     - name: Deploy to GitHub Actions
-      uses: JamesIves/github-pages-deploy-action@3.7.1
+      uses: JamesIves/github-pages-deploy-action@v4
       with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
+        token: ${{ secrets.BOT_PAT }}
+        git-config-name: Aaron Christiansen
+        git-config-email: aaronc20000+bot@gmail.com
         branch: gh-pages
         folder: doc

data/CHANGELOG.md

@@ -3,6 +3,19 @@ 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/).
 
+## [9.1.1] - 2025-05-28
+### Fixed
+- Replaced YARD `@abstract` directives, as they now conflict with Sorbet's `abstract!` directives
+  when using Tapioca
+
+## [9.1.0] - 2025-03-03
+### Added
+- Constants can now be generated or parsed with heredoc strings. (Thanks @apiology)
+
+### Fixed
+- `T.proc` types with no parameters are now emitted correctly. Previously, they emitted an invalid
+  call to `params()` - now they emit no usage of `params`. (Thanks @apiology)
+
 ## [9.0.0] - 2024-06-04
 ### Changed
 - Updated Commander dependency to 5.0, to remove `abbrev` deprecation warning. 

data/lib/parlour/plugin.rb

@@ -1,7 +1,8 @@
 # typed: true
 module Parlour
   # The base class for user-defined RBI generation plugins.
-  # @abstract
+  #
+  # This class is *abstract*.
   class Plugin
     extend T::Sig
     extend T::Helpers
@@ -57,7 +58,8 @@ module Parlour
     # Plugin subclasses should redefine this method and do their RBI generation
     # inside it.
     #
-    # @abstract
+    # This method is *abstract*.
+    #
     # @param root [RbiGenerator::Namespace] The root {RbiGenerator::Namespace}.
     # @return [void]
     def generate(root); end

data/lib/parlour/rbi_generator/constant.rb

@@ -9,6 +9,7 @@ module Parlour
           name: String,
           value: Types::TypeLike,
           eigen_constant: T::Boolean,
+          heredocs: T.nilable(String),
           block: T.nilable(T.proc.params(x: Constant).void)
         ).void
       end
@@ -18,9 +19,11 @@ module Parlour
       # @param value [String] The value of the constant, as a Ruby code string.
       # @param eigen_constant [Boolean] Whether this constant is defined on the
       #   eigenclass of the current namespace.
-      def initialize(generator, name: '', value: '', eigen_constant: false, &block)
+      # @param heredocs [String,nil] Definitions of the heredocs used in the value, if any
+      def initialize(generator, name: '', value: '', eigen_constant: false, heredocs: nil, &block)
         super(generator, name)
         @value = value
+        @heredocs = heredocs
         @eigen_constant = eigen_constant
         yield_self(&block) if block
       end
@@ -33,6 +36,9 @@ module Parlour
       #   of the current namespace.
       attr_reader :eigen_constant
 
+      # @return [String,nil] Definitions of the heredocs used in the value, if any
+      attr_reader :heredocs
+
       sig { params(other: Object).returns(T::Boolean) }
       # Returns true if this instance is equal to another extend.
       #
@@ -41,7 +47,7 @@ module Parlour
       # @return [Boolean]
       def ==(other)
         Constant === other && name == other.name && value == other.value \
-          && eigen_constant == other.eigen_constant
+          && eigen_constant == other.eigen_constant && heredocs == other.heredocs
       end
 
       sig do
@@ -57,9 +63,13 @@ module Parlour
       # @return [Array<String>] The RBI lines, formatted as specified.
       def generate_rbi(indent_level, options)
         if String === @value
-          [options.indented(indent_level, "#{name} = #{@value}")]
+          [
+            options.indented(indent_level, "#{name} = #{@value}"),
+          ] + [heredocs].compact
         else
-          [options.indented(indent_level, "#{name} = T.let(nil, #{@value.generate_rbi})")]
+          [
+            options.indented(indent_level, "#{name} = T.let(nil, #{@value.generate_rbi})"),
+          ] + [heredocs].compact
         end
       end
 
@@ -68,7 +78,7 @@ module Parlour
           others: T::Array[RbiGenerator::RbiObject]
         ).returns(T::Boolean)
       end
-      # Given an array of {Constant} instances, returns true if they may be 
+      # Given an array of {Constant} instances, returns true if they may be
       # merged into this instance using {merge_into_self}. This is always false.
       #
       # @param others [Array<RbiGenerator::RbiObject>] An array of other
@@ -97,14 +107,16 @@ module Parlour
 
       sig { override.returns(T::Array[T.any(Symbol, T::Hash[Symbol, String])]) }
       def describe_attrs
-        [:value, :eigen_constant]
+        [:value, :eigen_constant, :heredocs]
       end
 
       sig { override.void }
       def generalize_from_rbi!
-        # There's a good change this is an untyped constant, so rescue
-        # ParseError and use untyped
-        @value = (TypeParser.parse_single_type(@value) if String === @value) rescue Types::Untyped.new
+        if @value.is_a?(String)
+          # There's a good chance this is an untyped constant, so rescue
+          # ParseError and use untyped
+          @value = TypeParser.parse_single_type(@value) rescue Types::Untyped.new
+        end
       end
     end
   end

data/lib/parlour/rbi_generator/namespace.rb

@@ -564,7 +564,7 @@ module Parlour
         returned_includables
       end
 
-      sig { params(name: String, value: String, eigen_constant: T::Boolean, block: T.nilable(T.proc.params(x: Constant).void)).returns(Constant) }
+      sig { params(name: String, value: String, eigen_constant: T::Boolean, heredocs: T.nilable(String), block: T.nilable(T.proc.params(x: Constant).void)).returns(Constant) }
       # Adds a new constant definition to this namespace.
       #
       # @example Add an +Elem+ constant to the class.
@@ -574,14 +574,16 @@ module Parlour
       # @param value [String] The value of the constant, as a Ruby code string.
       # @param eigen_constant [Boolean] Whether this constant is defined on the
       #   eigenclass of the current namespace.
+      # @param heredocs [String,nil] Values of the heredocs used, in order
       # @param block A block which the new instance yields itself to.
       # @return [RbiGenerator::Constant]
-      def create_constant(name, value:, eigen_constant: false, &block)
+      def create_constant(name, value:, eigen_constant: false, heredocs: nil, &block)
         new_constant = RbiGenerator::Constant.new(
           generator,
           name: name,
           value: value,
           eigen_constant: eigen_constant,
+          heredocs: heredocs,
           &block
         )
         move_next_comments(new_constant)

data/lib/parlour/rbi_generator/rbi_object.rb

@@ -5,7 +5,8 @@ module Parlour
     # entire lines of an RBI, such as {Namespace} and {Method}. (As an example,
     # {Parameter} is _not_ a subclass because it does not generate lines, only
     # segments of definition and signature lines.)
-    # @abstract
+    # 
+    # This class is *abstract*.
     class RbiObject < TypedObject
       abstract!
       
@@ -35,7 +36,8 @@ module Parlour
       end
       # Generates the RBI lines for this object.
       #
-      # @abstract
+      # This method is *abstract*.
+      #
       # @param indent_level [Integer] The indentation level to generate the lines at.
       # @param options [Options] The formatting options to use.
       # @return [Array<String>] The RBI lines, formatted as specified.
@@ -50,7 +52,8 @@ module Parlour
       # into this instance using {merge_into_self}. Each subclass will have its
       # own criteria on what allows objects to be mergeable.
       #
-      # @abstract
+      # This method is *abstract*.
+      #
       # @param others [Array<RbiGenerator::RbiObject>] An array of other {RbiObject} instances.
       # @return [Boolean] Whether this instance may be merged with them.
       def mergeable?(others); end
@@ -64,7 +67,8 @@ module Parlour
       # subclass will do this differently.
       # You MUST ensure that {mergeable?} is true for those instances.
       #
-      # @abstract
+      # This method is *abstract*.
+      #
       # @param others [Array<RbiGenerator::RbiObject>] An array of other {RbiObject} instances.
       # @return [void]
       def merge_into_self(others); end
@@ -74,7 +78,8 @@ module Parlour
       # been specified as RBI-style types, generalises them into type instances
       # from the {Parlour::Types} module.
       #
-      # @abstract
+      # This method is *abstract*.
+      #
       # @return [void]
       def generalize_from_rbi!; end
     end

data/lib/parlour/rbs_generator/method.rb

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

data/lib/parlour/rbs_generator/rbs_object.rb

@@ -5,7 +5,8 @@ module Parlour
     # entire lines of an RBS, such as {Namespace} and {Method}. (As an example,
     # {Parameter} is _not_ a subclass because it does not generate lines, only
     # segments of definition lines.)
-    # @abstract
+    #
+    # This class is *abstract*.
     class RbsObject < TypedObject
       abstract!
       
@@ -35,7 +36,8 @@ module Parlour
       end
       # Generates the RBS lines for this object.
       #
-      # @abstract
+      # This method is *abstract*.
+      #
       # @param indent_level [Integer] The indentation level to generate the lines at.
       # @param options [Options] The formatting options to use.
       # @return [Array<String>] The RBS lines, formatted as specified.
@@ -50,7 +52,8 @@ module Parlour
       # into this instance using {merge_into_self}. Each subclass will have its
       # own criteria on what allows objects to be mergeable.
       #
-      # @abstract
+      # This method is *abstract*.
+      #
       # @param others [Array<RbsGenerator::RbsObject>] An array of other {RbsObject} instances.
       # @return [Boolean] Whether this instance may be merged with them.
       def mergeable?(others); end
@@ -64,7 +67,8 @@ module Parlour
       # subclass will do this differently.
       # You MUST ensure that {mergeable?} is true for those instances.
       #
-      # @abstract
+      # This method is *abstract*.
+      #
       # @param others [Array<RbsGenerator::RbsObject>] An array of other {RbsObject} instances.
       # @return [void]
       def merge_into_self(others); end

data/lib/parlour/type_parser.rb

@@ -380,10 +380,12 @@ module Parlour
             type: T.must(node_to_s(body.to_a[2])),
           )]
         else
+          heredocs = find_heredocs(body)
           [Parlour::RbiGenerator::Constant.new(
             generator,
             name: T.must(name).to_s,
             value: T.must(node_to_s(body)),
+            heredocs: heredocs
           )]
         end
       else
@@ -406,6 +408,43 @@ module Parlour
       prop :params, T.nilable(T::Array[Parser::AST::Node])
     end
 
+    sig { params(body: T.nilable(Parser::AST::Node)).returns(T.nilable(String)) }
+    # Given a node in the AST, finds all heredoc definitions within it
+    # and return them as a String
+    #
+    # e.g., for the AST for following code:
+    #
+    #  foo = <<~HEREDOC
+    #    bar
+    #  HEREDOC
+    #
+    # this method would return "  bar\nHEREDOC\n"
+    def find_heredocs(body)
+      heredocs = T.let(nil, T.nilable(String))
+
+      return heredocs if body.nil?
+
+      loc = body.loc
+
+      if loc.instance_of?(Parser::Source::Map::Heredoc)
+        return body.loc.expression.source_buffer.source[loc.heredoc_body.begin_pos...loc.heredoc_end.end_pos]
+      end
+
+      body.children.map do |child|
+        next unless child.instance_of?(Parser::AST::Node)
+
+        child_heredocs = find_heredocs(child)
+
+        next if child_heredocs.nil?
+
+        heredocs ||= ''
+        heredocs += child_heredocs
+        heredocs += "\n"
+      end
+
+      heredocs
+    end
+
     sig { params(path: NodePath).returns(IntermediateSig) }
     # Given a path to a sig in the AST, parses that sig into an intermediate
     # sig object.

data/lib/parlour/typed_object.rb

@@ -148,7 +148,8 @@ module Parlour
     #   - 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
+    # This method is *abstract*.
+    #
     # @return [<Symbol, String>]
     def describe_attrs; end
 

data/lib/parlour/types.rb

@@ -551,9 +551,9 @@ module Parlour
         rbi_params = parameters.map do |param|
           RbiGenerator::Parameter.new(param.name, type: param.type, default: param.default)
         end
-        "T.proc.params(#{rbi_params.map(&:to_sig_param).join(', ')}).#{
-          @return_type ? "returns(#{@return_type.generate_rbi})" : 'void'
-        }"
+        "T.proc." +
+          (rbi_params.empty? ? "" : "params(#{rbi_params.map(&:to_sig_param).join(', ')}).") +
+          (@return_type ? "returns(#{@return_type.generate_rbi})" : 'void')
       end
 
       sig { override.returns(String) }
@@ -575,4 +575,3 @@ module Parlour
     end
   end
 end
-

data/lib/parlour/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.1
 platform: ruby
 authors:
 - Aaron Christiansen
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2025-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -150,7 +149,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - hello@aaronc.cc
 executables:
@@ -228,7 +226,6 @@ homepage: https://github.com/AaronC81/parlour
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -243,8 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A type information generator, merger and parser for Sorbet and Ruby 3/Steep
 test_files: []