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

Merge pull request #111 from whopper/PDOC-95/master/multiple_defaultfor 

(PDOC-95) Properly group and display multiple provider `defaultfor`s
This commit is contained in:
Peter Huene 2016-10-11 15:33:39 -07:00 committed by GitHub
parent 8e911af5a9 a5a3d6b48c
commit 4f3f1e639e
8 changed files with 85 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
JSON.md
View File

@ -3,7 +3,7 @@ Puppet Strings JSON Data
Puppet Strings has two flags to the `generate` action that can be used to emit JSON data:
* `--emit-json <file>`: Emits the JSON data to the given file.
* `--emit-json <file>`: Emits the JSON data to the given file.
* `--emit-json-stdout`: Emits the JSON data to STDOUT.
Document Schema
@ -100,13 +100,13 @@ Each entry in the `providers` list is an object with the following attributes:
| Attribute Key | Description |
| ------------- | ---------------------------------------------------- |
| name | The name of the provider. |
| type_name | The name of the resource type of the provider. |
| type_name | The name of the resource type of the provider. |
| file | The file defining the provider. |
| line | The line where the provider is defined. |
| docstring | The *DocString* object for the provider (see below). |
| confines | The string map of confines for the provider. |
| features | The list of features implemented by the provider. |
| defaults | The string map of "default for" for the provider. |
| defaults | The list of lists of "default for" for the provider. |
| commands | The string map of commands for the provider. |
Puppet Functions
@ -327,9 +327,24 @@ An example JSON document describing a Puppet class, defined type, resource type,
"implements_some_feature",
"some_other_feature"
],
"defaults": {
"kernel": "Linux"
},
"defaults": [
[
[
"kernel",
"Linux"
]
],
[
[
"osfamily",
"RedHat",
],
[
"operatingsystemmajrelease",
"7"
]
]
],
"commands": {
"foo": "/usr/bin/foo"
}
@ -508,4 +523,3 @@ An example JSON document describing a Puppet class, defined type, resource type,
]
}
```

11
lib/puppet-strings/yard/code_objects/provider.rb
View File

@ -56,13 +56,12 @@ class PuppetStrings::Yard::CodeObjects::Provider < PuppetStrings::Yard::CodeObje
end
# Adds a default to the provider.
# @param [String] key The default's key.
# @param [String] value The default's value.
# @param [Array] constraints List of related key-pair values for the default.
# @return [void]
def add_default(key, value)
return unless key && value
@defaults ||= {}
@defaults[key] = value
def add_default(constraints)
return unless constraints
@defaults ||= []
@defaults << constraints
end
# Adds a command to the provider.

11
lib/puppet-strings/yard/handlers/ruby/provider_handler.rb
View File

@ -96,9 +96,14 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
elsif method_name == 'defaultfor'
# Add a default to the object
next unless parameters.count >= 1
parameters[0].each do |kvp|
next unless kvp.count == 2
object.add_default(node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source)
# Some defaultfor statements contain multiple constraints.
parameters.each do |kvps|
next unless kvps.count >= 1
defaultfor = []
kvps.each do |kvp|
defaultfor << [node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source]
end
object.add_default(defaultfor)
end
elsif method_name == 'commands'
# Add the commands to the object

11
lib/puppet-strings/yard/templates/default/puppet_provider/html/collection.erb
View File

@ -2,8 +2,15 @@
<div class="tags">
<p class="tag_title"><%= @title %></p>
<ul>
<% @collection.each do |key, value| %>
<li><tt><%= key %> &mdash; <%= value %></tt></li>
<% if @collection.is_a?(Hash) %>
<% @collection.each do |key, value| %>
<li><tt><%= key %> &mdash; <%= value %></tt></li>
<% end %>
<% elsif @collection.is_a?(Array) %>
<% @collection.each do |kvps| %>
<li><tt><%= kvps.map{|k,v| "#{k} &mdash; #{v}"}.join(', ') %></tt></li>
<% end %>
<% end %>
</ul>
</div>

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

@ -84,7 +84,7 @@
{
"name": "database",
"file": "(stdin)",
"line": 43,
"line": 44,
"docstring": {
"text": "An example database server resource type."
},
@ -166,9 +166,24 @@
"implements_some_feature",
"some_other_feature"
],
"defaults": {
"kernel": "Linux"
},
"defaults": [
[
[
"kernel",
"Linux"
]
],
[
[
"osfamily",
"RedHat"
],
[
"operatingsystemmajrelease",
"7"
]
]
],
"commands": {
"foo": "/usr/bin/foo"
}

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

@ -166,9 +166,24 @@
"implements_some_feature",
"some_other_feature"
],
"defaults": {
"kernel": "Linux"
},
"defaults": [
[
[
"kernel",
"Linux"
]
],
[
[
"osfamily",
"RedHat"
],
[
"operatingsystemmajrelease",
"7"
]
]
],
"commands": {
"foo": "/usr/bin/foo"
}

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

@ -69,7 +69,8 @@ Puppet::Type.type(:database).provide :linux do
desc 'An example provider on Linux.'
confine kernel: 'Linux'
confine osfamily: 'RedHat'
defaultfor kernel: 'Linux'
defaultfor :kernel => 'Linux'
defaultfor :osfamily => 'RedHat', :operatingsystemmajrelease => '7'
has_feature :implements_some_feature
has_feature :some_other_feature
commands foo: /usr/bin/foo

5
spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb
View File

@ -61,7 +61,8 @@ Puppet::Type.type(:custom).provide :linux do
desc 'An example provider on Linux.'
confine kernel: 'Linux'
confine osfamily: 'RedHat'
defaultfor kernel: 'Linux'
defaultfor :kernel => 'Linux'
defaultfor :osfamily => 'RedHat', :operatingsystemmajrelease => '7'
has_feature :implements_some_feature
has_feature :some_other_feature
commands foo: /usr/bin/foo
@ -82,7 +83,7 @@ SOURCE
expect(tags.size).to eq(1)
expect(tags[0].text).to eq('public')
expect(object.confines).to eq({ 'kernel' => 'Linux', 'osfamily' => 'RedHat'})
expect(object.defaults).to eq({ 'kernel' => 'Linux'})
expect(object.defaults).to eq([[["kernel", "Linux"]], [["osfamily", "RedHat"], ["operatingsystemmajrelease", "7"]]])
expect(object.features).to eq(['implements_some_feature', 'some_other_feature'])
expect(object.commands).to eq({'foo' => '/usr/bin/foo'})
end