kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #122 from whopper/PDOC-129/master/overload-empty-docstring 

(PDOC-129) Include tags in overload objects when serialized as JSON
This commit is contained in:
Jesse Scott 2016-11-14 12:51:38 -08:00 committed by GitHub
parent df8e58b0c8 c56d9c60a4
commit 70d5b1ccd7
4 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/puppet-strings/yard/tags/overload_tag.rb
View File

@ -99,7 +99,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
hash[:tag_name] = tag_name hash[:tag_name] = tag_name
hash[:text] = text if text hash[:text] = text if text
hash[:signature] = signature hash[:signature] = signature
hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring) if !docstring.empty? hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring) if !docstring.blank?
defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten] defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
hash[:defaults] = defaults unless defaults.empty? hash[:defaults] = defaults unless defaults.empty?
hash[:types] = types if types hash[:types] = types if types

8
spec/fixtures/unit/json/output.json vendored
View File

@ -84,7 +84,7 @@
{ {
"name": "database", "name": "database",
"file": "(stdin)", "file": "(stdin)",
"line": 46, "line": 45,
"docstring": { "docstring": {
"text": "An example database server resource type." "text": "An example database server resource type."
}, },
@ -154,7 +154,7 @@
"name": "linux", "name": "linux",
"type_name": "database", "type_name": "database",
"file": "(stdin)", "file": "(stdin)",
"line": 35, "line": 34,
"docstring": { "docstring": {
"text": "An example provider on Linux." "text": "An example provider on Linux."
}, },
@ -326,7 +326,7 @@
"tag_name": "overload", "tag_name": "overload",
"signature": "func4x(Boolean $param, Callable &$block)", "signature": "func4x(Boolean $param, Callable &$block)",
"docstring": { "docstring": {
"text": "The second overload.", "text": "",
"tags": [ "tags": [
{ {
"tag_name": "param", "tag_name": "param",
@ -357,7 +357,7 @@
} }
] ]
}, },
"source": "Puppet::Functions.create_function(:func4x) do\n # The first overload.\n # @param param1 The first parameter.\n # @param param2 The second parameter.\n # @param param3 The third parameter.\n # @return Returns nothing.\n dispatch :foo do\n param 'Integer', :param1\n param 'Any', :param2\n optional_param 'Array[String]', :param3\n return_type 'Undef'\n end\n\n # The second overload.\n # @param param The first parameter.\n # @param block The block parameter.\n # @return Returns a string.\n dispatch :other do\n param 'Boolean', :param\n block_param\n return_type 'String'\n end\nend" "source": "Puppet::Functions.create_function(:func4x) do\n # The first overload.\n # @param param1 The first parameter.\n # @param param2 The second parameter.\n # @param param3 The third parameter.\n # @return Returns nothing.\n dispatch :foo do\n param 'Integer', :param1\n param 'Any', :param2\n optional_param 'Array[String]', :param3\n return_type 'Undef'\n end\n\n # @param param The first parameter.\n # @param block The block parameter.\n # @return Returns a string.\n dispatch :other do\n param 'Boolean', :param\n block_param\n return_type 'String'\n end\nend"
} }
] ]
} }

8
spec/fixtures/unit/json/output_without_puppet_function.json vendored
View File

@ -84,7 +84,7 @@
{ {
"name": "database", "name": "database",
"file": "(stdin)", "file": "(stdin)",
"line": 46, "line": 45,
"docstring": { "docstring": {
"text": "An example database server resource type." "text": "An example database server resource type."
}, },
@ -154,7 +154,7 @@
"name": "linux", "name": "linux",
"type_name": "database", "type_name": "database",
"file": "(stdin)", "file": "(stdin)",
"line": 35, "line": 34,
"docstring": { "docstring": {
"text": "An example provider on Linux." "text": "An example provider on Linux."
}, },
@ -279,7 +279,7 @@
"tag_name": "overload", "tag_name": "overload",
"signature": "func4x(Boolean $param, Callable &$block)", "signature": "func4x(Boolean $param, Callable &$block)",
"docstring": { "docstring": {
"text": "The second overload.", "text": "",
"tags": [ "tags": [
{ {
"tag_name": "param", "tag_name": "param",
@ -310,7 +310,7 @@
} }
] ]
}, },
"source": "Puppet::Functions.create_function(:func4x) do\n # The first overload.\n # @param param1 The first parameter.\n # @param param2 The second parameter.\n # @param param3 The third parameter.\n # @return Returns nothing.\n dispatch :foo do\n param 'Integer', :param1\n param 'Any', :param2\n optional_param 'Array[String]', :param3\n return_type 'Undef'\n end\n\n # The second overload.\n # @param param The first parameter.\n # @param block The block parameter.\n # @return Returns a string.\n dispatch :other do\n param 'Boolean', :param\n block_param\n return_type 'String'\n end\nend" "source": "Puppet::Functions.create_function(:func4x) do\n # The first overload.\n # @param param1 The first parameter.\n # @param param2 The second parameter.\n # @param param3 The third parameter.\n # @return Returns nothing.\n dispatch :foo do\n param 'Integer', :param1\n param 'Any', :param2\n optional_param 'Array[String]', :param3\n return_type 'Undef'\n end\n\n # @param param The first parameter.\n # @param block The block parameter.\n # @return Returns a string.\n dispatch :other do\n param 'Boolean', :param\n block_param\n return_type 'String'\n end\nend"
} }
] ]
} }

1
spec/unit/puppet-strings/json_spec.rb
View File

@ -56,7 +56,6 @@ Puppet::Functions.create_function(:func4x) do
return_type 'Undef' return_type 'Undef'
end end
# The second overload.
# @param param The first parameter. # @param param The first parameter.
# @param block The block parameter. # @param block The block parameter.
# @return Returns a string. # @return Returns a string.