Add support for multiple & nested Hash keys definition

Author: lekemula

lib/yard/tags/types_explainer.rb

@@ -89,18 +89,56 @@ def to_s(_singular = true)
 
       # @private
       class HashCollectionType < Type
-        attr_accessor :key_types, :value_types
+        attr_accessor :key_value_pairs
 
-        def initialize(name, key_types, value_types)
+        def initialize(name, key_types_or_pairs, value_types = nil)
           @name = name
-          @key_types = key_types
-          @value_types = value_types
+
+          if value_types.nil?
+            # New signature: (name, key_value_pairs)
+            @key_value_pairs = key_types_or_pairs || []
+          else
+            # Old signature: (name, key_types, value_types)
+            @key_value_pairs = [[key_types_or_pairs, value_types]]
+          end
+        end
+
+        # Backward compatibility accessors
+        def key_types
+          return [] if @key_value_pairs.empty?
+          @key_value_pairs.first[0] || []
+        end
+
+        def key_types=(types)
+          if @key_value_pairs.empty?
+            @key_value_pairs = [[types, []]]
+          else
+            @key_value_pairs[0][0] = types
+          end
+        end
+
+        def value_types
+          return [] if @key_value_pairs.empty?
+          @key_value_pairs.first[1] || []
+        end
+
+        def value_types=(types)
+          if @key_value_pairs.empty?
+            @key_value_pairs = [[[], types]]
+          else
+            @key_value_pairs[0][1] = types
+          end
         end
 
         def to_s(_singular = true)
-          "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} with keys made of (" +
-            list_join(key_types.map {|t| t.to_s(false) }) +
-            ") and values of (" + list_join(value_types.map {|t| t.to_s(false) }) + ")"
+          return "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name}" if @key_value_pairs.empty?
+
+          result = "a#{name[0, 1] =~ /[aeiou]/i ? 'n' : ''} #{name} with "
+          parts = @key_value_pairs.map do |keys, values|
+            "keys made of (" + list_join(keys.map {|t| t.to_s(false) }) +
+            ") and values of (" + list_join(values.map {|t| t.to_s(false) }) + ")"
+          end
+          result + parts.join(" and ")
         end
       end
 
@@ -114,11 +152,13 @@ class Parser
           :fixed_collection_start => /\(/,
           :fixed_collection_end => /\)/,
           :type_name => /#{ISEP}#{METHODNAMEMATCH}|#{NAMESPACEMATCH}|#{LITERALMATCH}|\w+/,
-          :type_next => /[,;]/,
+          :type_next => /[,]/,
           :whitespace => /\s+/,
           :hash_collection_start => /\{/,
-          :hash_collection_next => /=>/,
+          :hash_collection_value => /=>/,
+          :hash_collection_value_end => /;/,
           :hash_collection_end => /\}/,
+          # :symbol_start => /:/,
           :parse_end => nil
         }
 
@@ -130,43 +170,90 @@ def initialize(string)
           @scanner = StringScanner.new(string)
         end
 
-        def parse
-          types = []
+        # @return [Array(Boolean, Array<Type>)] - finished, types
+        def parse(until_tokens: [:parse_end])
+          current_parsed_types = []
           type = nil
           name = nil
+          finished = false
+          parse_with_handlers do |token_type, token|
+            case token_type
+            when *until_tokens
+              raise SyntaxError, "expecting name, got '#{token}'" if name.nil?
+              type = create_type(name) unless type
+              current_parsed_types << type
+              finished = true
+            when :type_name
+              raise SyntaxError, "expecting END, got name '#{token}'" if name
+              name = token
+            when :type_next
+              raise SyntaxError, "expecting name, got '#{token}' at #{@scanner.pos}" if name.nil?
+              type = create_type(name) unless type
+              current_parsed_types << type
+              name = nil
+              type = nil
+            when :fixed_collection_start, :collection_start
+              name ||= "Array"
+              klass = token_type == :collection_start ? CollectionType : FixedCollectionType
+              type = klass.new(name, parse(until_tokens: [:fixed_collection_end, :collection_end, :parse_end]))
+            when :hash_collection_start
+              name ||= "Hash"
+              type = parse_hash_collection(name)
+            end
+
+            [finished, current_parsed_types]
+          end
+        end
+
+        private
+
+        # @return [Array<Type>]
+        # @yield_return [Array<Ty[]]
+        def parse_with_handlers
           loop do
             found = false
             TOKENS.each do |token_type, match|
               # TODO: cleanup this code.
               # rubocop:disable Lint/AssignmentInCondition
               next unless (match.nil? && @scanner.eos?) || (match && token = @scanner.scan(match))
               found = true
-              case token_type
-              when :type_name
-                raise SyntaxError, "expecting END, got name '#{token}'" if name
-                name = token
-              when :type_next
-                raise SyntaxError, "expecting name, got '#{token}' at #{@scanner.pos}" if name.nil?
-                type = create_type(name) unless type
-                types << type
-                type = nil
-                name = nil
-              when :fixed_collection_start, :collection_start
-                name ||= "Array"
-                klass = token_type == :collection_start ? CollectionType : FixedCollectionType
-                type = klass.new(name, parse)
-              when :hash_collection_start
-                name ||= "Hash"
-                type = HashCollectionType.new(name, parse, parse)
-              when :hash_collection_next, :hash_collection_end, :fixed_collection_end, :collection_end, :parse_end
-                raise SyntaxError, "expecting name, got '#{token}'" if name.nil?
-                type = create_type(name) unless type
-                types << type
-                return types
-              end
+              # @type [Array<Type>]
+              finished, types = yield(token_type, token)
+              return types if finished
+              break
             end
             raise SyntaxError, "invalid character at #{@scanner.peek(1)}" unless found
           end
+          nil
+        end
+
+        def parse_hash_collection(name)
+          key_value_pairs = []
+          current_keys = []
+          finished = false
+
+          parse_with_handlers do |token_type, token|
+            case token_type
+            when :type_name
+              current_keys << create_type(token)
+            when :type_next
+              # Comma - continue collecting keys unless we just processed a value
+              # In that case, start a new key group
+            when :hash_collection_value
+              # => - current keys map to the next value(s)
+              raise SyntaxError, "no keys before =>" if current_keys.empty?
+              values = parse(until_tokens: [:hash_collection_value_end, :parse_end])
+              key_value_pairs << [current_keys, values]
+              current_keys = []
+            when :hash_collection_end, :parse_end
+              # End of hash
+              finished = true
+            when :whitespace
+              # Ignore whitespace
+            end
+
+            [finished, HashCollectionType.new(name, key_value_pairs)]
+          end
         end
 
         private

spec/tags/types_explainer_spec.rb

@@ -218,7 +218,10 @@ def parse_fail(types)
         "#weird_method?, #<=>, #!=" => "an object that responds to #weird_method?;
           an object that responds to #<=>;
           an object that responds to #!=",
-        ":symbol, 'string'" => "a literal value :symbol; a literal value 'string'"
+        ":symbol, 'string'" => "a literal value :symbol; a literal value 'string'",
+        "Hash{:key_one, :key_two => String; :key_three => Symbol}" => "a Hash with keys made of (a literal value :key_one or a literal value :key_two) and values of (Strings) and keys made of (a literal value :key_three) and values of (Symbols)",
+        "Hash{:key_one, :key_two => String; :key_three => Symbol; :key_four => Hash{:sub_key_one => String}}" => "a Hash with keys made of (a literal value :key_one or a literal value :key_two) and values of (Strings) and keys made of (a literal value :key_three) and values of (Symbols) and keys made of (a literal value :key_four) and values of (a Hash with keys made of (a literal value :sub_key_one) and values of (Strings))",
+        "Hash{:key_one => String, Number; :key_two => String}" => "a Hash with keys made of (a literal value :key_one) and values of (Strings or Numbers) and keys made of (a literal value :key_two) and values of (Strings)"
       }
       expect.each do |input, expected|
         explain = YARD::Tags::TypesExplainer.explain(input)