Fix bug in display of all extensions that define a parameter in a CRD.

Author: james-ball-qualcomm

backends/manual/templates/param_list.adoc.erb

@@ -12,7 +12,7 @@ The following <%= params.size %> parameters are defined in this manual:
 <%- params.each do |param| -%>
 | <%= param.name %>
 | <%= param.schema.to_pretty_s %>
-| <%= param.exts.map { |ext| link_to_udb_doc_ext_param(ext.name, param.name) }.join(", ") %>
+| <%= param.exts.map { |ext| link_to_udb_doc_ext_param(ext.name, param.name, ext.name) }.join(", ") %>
 a| <%= param.desc %>
 <%- end -%>
 |===

backends/portfolio/templates/coverage_points.adoc.erb

@@ -8,7 +8,7 @@ Coverage Points for `<%= nice_name %>`: ::
 
 [%autowidth]
 |===
-| ID | Name | Description | Links
+| ID | Name | Description | Documentation Links
 
 <% db_obj.cert_coverage_points.each do |cp| -%>
 | <%= defined?(org) ? anchor_for_udb_cert_cov_pt(org, cp.id) : "" %><%= cp.id %>

backends/proc_crd/templates/proc_crd.adoc.erb

@@ -235,7 +235,7 @@ None
 | <%= param.name_potentially_with_link(in_scope_exts) %>
 | <%= param.schema_type %>
 | <%= in_scope_param.allowed_values %>
-| <%= in_scope_exts.each { |ext| param.name_with_link(ext) } %>
+| <%= in_scope_exts.map { |ext| link_to_udb_doc_ext_param(ext.name, param.name, ext.name) }.join(", ") %>
 a| <%= in_scope_param.note %>
 <% end # do -%>
 |===
@@ -258,7 +258,7 @@ None
 <% exts = portfolio_design.all_in_scope_exts_without_param(param) -%>
 | <%= param.name_potentially_with_link(exts) %>
 | <%= param.schema_type %>
-| <%= exts.each { |ext| param.name_with_link(ext) } %>
+| <%= exts.map { |ext| link_to_udb_doc_ext_param(ext.name, param.name, ext.name) }.join(", ") %>
 
 <% end # do -%>
 |===

lib/arch_obj_models/parameter.rb

@@ -40,33 +40,39 @@ def schema_type
   # @param name [String]
   # @param data [Hash<String, Object]
   def initialize(ext, name, data)
+    raise ArgumentError, "Expecting Extension but got #{ext.class}" unless ext.is_a?(Extension)
+    raise ArgumentError, "Expecting String but got #{name.class}" unless name.is_a?(String)
+    raise ArgumentError, "Expecting Hash but got #{data.class}" unless data.is_a?(Hash)
+
     @arch = ext.arch
     @data = data
     @name = name
     @desc = data["description"]
     @schema = Schema.new(data["schema"])
     @extra_validation = data["extra_validation"]
-    also_defined_in = []
-    unless data["also_defined_in"].nil?
-      if data["also_defined_in"].is_a?(String)
-        other_ext = @arch.extension(data["also_defined_in"])
-        raise "Definition error in #{ext.name}.#{name}: #{data['also_defined_in']} is not a known extension" if other_ext.nil?
-
-        also_defined_in << other_ext
+    also_defined_in_array = []
+    also_defined_in_data = data["also_defined_in"]
+    unless also_defined_in_data.nil?
+      if also_defined_in_data.is_a?(String)
+        other_ext_name = also_defined_in_data
+        other_ext = @arch.extension(other_ext_name)
+        raise "Definition error in #{ext.name}.#{name}: #{other_ext_name} is not a known extension" if other_ext.nil?
+
+        also_defined_in_array << other_ext
       else
-        unless data["also_defined_in"].is_a?(Array) && data["also_defined_in"].all? { |e| e.is_a?(String) }
+        unless also_defined_in_data.is_a?(Array) && also_defined_in_data.all? { |e| e.is_a?(String) }
           raise "schema error: also_defined_in should be a string or array of strings"
         end
 
-        data["also_defined_in"].each do |other_ext_name|
+        also_defined_in_data.each do |other_ext_name|
           other_ext = @arch.extension(other_ext_name)
-          raise "Definition error in #{ext.name}.#{name}: #{data['also_defined_in']} is not a known extension" if other_ext.nil?
+          raise "Definition error in #{ext.name}.#{name}: #{also_defined_in_data} is not a known extension" if other_ext.nil?
 
-          also_defined_in << other_ext
+          also_defined_in_array << other_ext
         end
       end
     end
-    @exts = [ext] + also_defined_in
+    @exts = [ext] + also_defined_in_array
     @idl_type = @schema.to_idl_type.make_const.freeze
   end
 
@@ -81,22 +87,15 @@ def defined_in_extension_version?(version)
     end
   end
 
-  # @param ext [Extension] Extension that defines this parameter.
-  # @return [String] Text that includes the parameter name and a link to the parameter definition.
-  #                  Should only be called if there is only one in-scope extension that defines the parameter.
-  def name_with_link(ext)
-    link_to_udb_doc_ext_param(ext.name, name)
-  end
-
   # @param exts [Array<Extension>] List of all in-scope extensions that define this parameter.
-  # @return [String] Text that includes the parameter name and a link to the parameter definition
+  # @return [String] Text to create a link to the parameter definition with the link text the parameter name.
   #                  if only one extension defines the parameter, otherwise just the parameter name.
   def name_potentially_with_link(in_scope_exts)
-    raise ArgumentError, "Expecting Array" unless in_scope_exts.is_a?(Array)
+    raise ArgumentError, "Expecting Array but got #{in_scope_exts.class}" unless in_scope_exts.is_a?(Array)
     raise ArgumentError, "Expecting Array[Extension]" unless in_scope_exts[0].is_a?(Extension)
 
     if in_scope_exts.size == 1
-      link_to_udb_doc_ext_param(in_scope_exts[0].name, name)
+      link_to_udb_doc_ext_param(in_scope_exts[0].name, name, name)
     else
       name
     end

lib/backend_helpers.rb

@@ -56,9 +56,10 @@ def link_to_udb_doc_ext(ext_name)
   # @return [String] A hyperlink to UDB parameter documentation
   # @param ext_name [String] Name of the extension
   # @param param_name [String] Name of the parameter
-  def link_to_udb_doc_ext_param(ext_name, param_name)
+  # @param link_text [String] What to put in the link text (don't assume param_name)
+  def link_to_udb_doc_ext_param(ext_name, param_name, link_text)
     check_no_periods(param_name)
-    "%%UDB_DOC_LINK%ext_param;#{ext_name.sanitize}.#{param_name};#{param_name}%%"
+    "%%UDB_DOC_LINK%ext_param;#{ext_name.sanitize}.#{param_name};#{link_text}%%"
   end
 
   # @return [String] A hyperlink to UDB instruction documentation

lib/test/test_backend_helpers.rb

@@ -17,11 +17,11 @@ def test_ext
   end
 
   def test_ext_param
-    assert_equal("%%UDB_DOC_LINK%ext_param;foo.bar;bar%%", link_to_udb_doc_ext_param("foo","bar"))
+    assert_equal("%%UDB_DOC_LINK%ext_param;foo.bar;zort%%", link_to_udb_doc_ext_param("foo","bar","zort"))
     assert_equal("[#udb:doc:ext_param:foo:bar]", anchor_for_udb_doc_ext_param("foo","bar"))
-    assert_equal("%%UDB_DOC_LINK%ext_param;fo_o.bar;bar%%", link_to_udb_doc_ext_param("fo.o","bar"))
+    assert_equal("%%UDB_DOC_LINK%ext_param;fo_o.bar;fluffy%%", link_to_udb_doc_ext_param("fo.o","bar","fluffy"))
     assert_equal("[#udb:doc:ext_param:fo_o:bar]", anchor_for_udb_doc_ext_param("fo.o","bar"))
-    assert_raises(ArgumentError) { link_to_udb_doc_ext_param("foo","ba.r") }
+    assert_raises(ArgumentError) { link_to_udb_doc_ext_param("foo","ba.r","fluffy") }
     assert_raises(ArgumentError) { anchor_for_udb_doc_ext_param("foo","ba.r") }
   end
 
@@ -77,7 +77,7 @@ def test_resolve_links_ext
 
   def test_resolve_links_ext_param
     assert_equal("<<udb:doc:ext_param:foo:bar,zort>>", AsciidocUtils.resolve_links("%%UDB_DOC_LINK%ext_param;foo.bar;zort%%"))
-    assert_equal("<<udb:doc:ext_param:foo:bar,bar>>", AsciidocUtils.resolve_links(link_to_udb_doc_ext_param("foo","bar")))
+    assert_equal("<<udb:doc:ext_param:foo:bar,bob>>", AsciidocUtils.resolve_links(link_to_udb_doc_ext_param("foo","bar","bob")))
   end
 
   def test_resolve_links_inst
@@ -121,7 +121,7 @@ def test_resolve_links_ext
 
   def test_resolve_links_ext_param
     assert_equal("xref:exts:foo.adoc#udb:doc:ext_param:foo:bar[[zort\\]]", AntoraUtils.resolve_links("%%UDB_DOC_LINK%ext_param;foo.bar;[zort]%%"))
-    assert_equal("xref:exts:foo.adoc#udb:doc:ext_param:foo:bar[bar]", AntoraUtils.resolve_links(link_to_udb_doc_ext_param("foo","bar")))
+    assert_equal("xref:exts:foo.adoc#udb:doc:ext_param:foo:bar[bob]", AntoraUtils.resolve_links(link_to_udb_doc_ext_param("foo","bar","bob")))
   end
 
   def test_resolve_links_inst