parlour 8.1.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3849a9995ec5ce41eeee0c180ac14d76d6e5ee2c7c7f9ecd61760d4279fc887
-  data.tar.gz: bd5ee90c62e2c55eebd233fec2bff3a0974e24204d79cecc627bce48e413dd64
+  metadata.gz: 4f18ccd38395c2840b06304074efe58ed6b0f72b6c12bf727234b182adce886d
+  data.tar.gz: afea2a669210749f9ad5bd8eb59eba9a02dfbbc4ef8069905a0c7fcfaef28f1a
 SHA512:
-  metadata.gz: 2de0e9b4aa6cd1c52a55453b7bf03da1247815a090de02ae0b105057c16e1aad0ed1ddf32d20dffc0727510321fb69b902b07a7e0bd03f268cb7331c0449b8cc
-  data.tar.gz: af13b87ff52638b9cefb29356dd7dec277667ef36ff656b4ced99c348cb9252828345c3de7f20d443594a7c09757ecd273e33d704df00109e5e4d2eafd5d3b0d
+  metadata.gz: 20da270743193873e21be0422e6d834b3aa4fa042ad4e1e44eab1ec5abcf5a70ef1a67178cb4946155ed7776354d1e7ad918511d3fa8aec44b79150212764dfa
+  data.tar.gz: c751ab8c92da95ddf0450c1ab5259a87e8c88b9443cb2628d53a8dbec85830f0b5016271f56d0c0300250bde212dff361f9b46c5b29e5df1f8eb732970a8adf9

data/.github/workflows/ruby.yml

@@ -10,7 +10,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2]
+        ruby: [3.0, 3.1, 3.2]
     continue-on-error: false
       
     runs-on: ubuntu-latest    
@@ -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.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. 
+  **As a result, the minimum supported Ruby version is now 3.0.**
+
 ## [8.1.0] - 2023-01-01
 ### Added
 - Parsed method definitions can now have a modifier before the `def` keyword.

data/lib/parlour/rbi_generator/attribute.rb

@@ -36,11 +36,11 @@ module Parlour
         @class_attribute = class_attribute
         case kind
         when :accessor, :reader
-          super(generator, name, [], type, &block)
+          super(generator, name, [], type, &T.cast(block, T.nilable(T.proc.params(x: Method).void)))
         when :writer
           super(generator, name, [
             Parameter.new(name, type: type)
-          ], type, &block)
+          ], type, &T.cast(block, T.nilable(T.proc.params(x: Method).void)))
         else
           raise 'unknown kind'
         end

data/lib/parlour/rbi_generator/class_namespace.rb

@@ -31,7 +31,7 @@ module Parlour
       # @param block A block which the new instance yields itself to.
       # @return [void]
       def initialize(generator, name, final, sealed, superclass, abstract, &block)
-        super(generator, name, final, sealed, &block)
+        super(generator, name, final, sealed, &T.cast(block, T.nilable(T.proc.params(x: Namespace).void)))
         @superclass = superclass
         @abstract = abstract
       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/enum_class_namespace.rb

@@ -30,7 +30,7 @@ module Parlour
       # @param block A block which the new instance yields itself to.
       # @return [void]
       def initialize(generator, name, final, sealed, enums, abstract, &block)
-        super(generator, name, final, sealed, 'T::Enum', abstract, &block)
+        super(generator, name, final, sealed, 'T::Enum', abstract, &T.cast(block, T.nilable(T.proc.params(x: Namespace).void)))
         @enums = enums
       end
 

data/lib/parlour/rbi_generator/module_namespace.rb

@@ -31,7 +31,7 @@ module Parlour
       # @param block A block which the new instance yields itself to.
       # @return [void]
       def initialize(generator, name, final, sealed, interface, abstract, &block)
-        super(generator, name, final, sealed, &block)
+        super(generator, name, final, sealed, &T.cast(block, T.nilable(T.proc.params(x: Namespace).void)))
         @name = name
         @interface = interface
         @abstract = abstract

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/struct_class_namespace.rb

@@ -31,7 +31,7 @@ module Parlour
       # @param block A block which the new instance yields itself to.
       # @return [void]
       def initialize(generator, name, final, sealed, props, abstract, &block)
-        super(generator, name, final, sealed, 'T::Struct', abstract, &block)
+        super(generator, name, final, sealed, 'T::Struct', abstract, &T.cast(block, T.nilable(T.proc.params(x: Namespace).void)))
         @props = props
       end
 

data/lib/parlour/rbs_generator/attribute.rb

@@ -29,11 +29,11 @@ module Parlour
         @kind = kind
         case kind
         when :accessor, :reader
-          super(generator, name, [MethodSignature.new([], type)], &block)
+          super(generator, name, [MethodSignature.new([], type)], &T.cast(block, T.nilable(T.proc.params(x: Method).void)))
         when :writer
           super(generator, name, [MethodSignature.new([
             Parameter.new(name, type: type)
-          ], type)], &block)
+          ], type)], &T.cast(block, T.nilable(T.proc.params(x: Method).void)))
         else
           raise 'unknown kind'
         end

data/lib/parlour/rbs_generator/class_namespace.rb

@@ -25,7 +25,7 @@ module Parlour
       # @param block A block which the new instance yields itself to.
       # @return [void]
       def initialize(generator, name, superclass, &block)
-        super(generator, name, &block)
+        super(generator, name, &T.cast(block, T.nilable(T.proc.params(x: Namespace).void)))
         @superclass = superclass
       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/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/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 = '8.1.0'
+  VERSION = '9.1.0'
 end

data/parlour.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "sorbet-runtime", ">= 0.5"
   spec.add_dependency "rainbow", "~> 3.0"
-  spec.add_dependency "commander", "~> 4.5"
+  spec.add_dependency "commander", "~> 5.0"
   spec.add_dependency "parser"
 
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-01 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A type information generator, merger and parser for Sorbet and Ruby 3/Steep