puppet_readme_generator 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: e785cee37db01e0ea247e8fee2f9c3bd28918864
4
+ data.tar.gz: 925b80d0a901a692e194ba5c839c442269e250cf
5
+ SHA512:
6
+ metadata.gz: 7e11e592e70ca62e79e7b7603eb7ed350ca734c2cd9e12a1c1fe7d834a2b97c4ea0fe32f61e7b66b9f2594fe90cf0eaf1d5b29ab6deb8b759a8a9e1c2d506de1
7
+ data.tar.gz: 67d437f96e5fbdc0cb7090c1642c7b65853eb0b9af0aad95558971a620a2129792c6e214f3c851be4739a7ac76668547ae599bf65fc3f95f53048d31223fd575
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3.1
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at simon@swine.de. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in puppet_readme_generator.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Christian Simon
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1 @@
1
+ # PuppetReadmeGenerator
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'puppet_readme_generator'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,12 @@
1
+ require 'puppet_readme_generator'
2
+
3
+ # Implements the strings:generate task.
4
+ namespace :readme do
5
+ desc 'Generate a README.md for this Puppet module'
6
+ task :generate do
7
+ g = PuppetReadmeGenerator::Generator.new
8
+ open('README.md', 'w') do |f|
9
+ f.puts g.markdown
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,8 @@
1
+ require 'rake'
2
+ require 'rake/tasklib'
3
+
4
+ module PuppetReadmeGenerator
5
+ module Tasks
6
+ require 'puppet_readme_generator/tasks/generate.rb'
7
+ end
8
+ end
@@ -0,0 +1,3 @@
1
+ module PuppetReadmeGenerator
2
+ VERSION = '0.1.0'.freeze
3
+ end
@@ -0,0 +1,183 @@
1
+ require 'puppet_readme_generator/version'
2
+ require 'puppet-strings'
3
+ require 'json'
4
+
5
+ module PuppetReadmeGenerator
6
+ class Generator
7
+ def initialize
8
+ patterns ||= PuppetStrings::DEFAULT_SEARCH_PATTERNS
9
+ options = {}
10
+ options[:json] = 'documentation.json'
11
+ PuppetStrings.generate(patterns, options)
12
+ end
13
+
14
+ def markdown
15
+ output = []
16
+ output << "# #{puppet_module}\n"
17
+ output << "#### Table of Contents\n"
18
+ output << '1. [Description](#description)'
19
+ output << '2. [Classes](#classes)'
20
+ output << '3. [Defined Types](#defined-types)'
21
+
22
+ output << '## Description'
23
+ output << main_class.text
24
+ output << ''
25
+
26
+ output << '## Classes'
27
+ classes.each do |c|
28
+ output << ''
29
+ output << c.markdown
30
+ end
31
+
32
+ output << '## DefinedTypes'
33
+ defined_types.each do |dt|
34
+ output << ''
35
+ output << dt.markdown
36
+ end
37
+
38
+ output.join("\n")
39
+ end
40
+
41
+ def documentation_path
42
+ 'documentation.json'
43
+ end
44
+
45
+ def documentation
46
+ @documentation ||= JSON.parse(File.open(documentation_path).read)
47
+ end
48
+
49
+ def metadata_path
50
+ 'metadata.json'
51
+ end
52
+
53
+ def metadata
54
+ @metadata ||= JSON.parse(File.open(metadata_path).read)
55
+ end
56
+
57
+ def puppet_module
58
+ metadata['name'].split('-')[1]
59
+ end
60
+
61
+ def main_class
62
+ classes.each do |c|
63
+ return c if c.name == puppet_module
64
+ end
65
+ nil
66
+ end
67
+
68
+ def classes
69
+ if @classes.nil?
70
+ @classes = documentation['puppet_classes'].map do |c|
71
+ Class.new c
72
+ end
73
+ end
74
+ @classes
75
+ end
76
+
77
+ def defined_types
78
+ if @defined_types.nil?
79
+ @defined_types = documentation['defined_types'].map do |c|
80
+ DefinedType.new c
81
+ end
82
+ end
83
+ @defined_types
84
+ end
85
+ end
86
+
87
+ class ClassAbstract
88
+ def initialize(c)
89
+ @c = c
90
+ end
91
+
92
+ def name
93
+ @c['name']
94
+ end
95
+
96
+ def text
97
+ @c['docstring']['text']
98
+ end
99
+
100
+ def examples
101
+ if @examples.nil?
102
+ @examples = []
103
+ @c['docstring']['tags'].each do |t|
104
+ next unless t['tag_name'] == 'example'
105
+ @examples << Example.new(t, self)
106
+ end
107
+ end
108
+ @examples
109
+ end
110
+
111
+ def params
112
+ if @params.nil?
113
+ @params = []
114
+ @c['docstring']['tags'].each do |t|
115
+ next unless t['tag_name'] == 'param'
116
+ @params << Param.new(t, self)
117
+ end
118
+ end
119
+ @params
120
+ end
121
+
122
+ def markdown
123
+ output = []
124
+ output << "### `#{@c['name']}`\n"
125
+ output << text
126
+ output << ''
127
+
128
+ output << "#### Parameters\n"
129
+ params.each do |p|
130
+ output << p.markdown
131
+ end
132
+
133
+ output << "#### Examples\n"
134
+ examples.each do |e|
135
+ output << e.markdown
136
+ end
137
+
138
+ output.join("\n")
139
+ end
140
+
141
+ def defaults
142
+ @c['defaults']
143
+ end
144
+ end
145
+
146
+ class Class < ClassAbstract
147
+ end
148
+
149
+ class DefinedType < ClassAbstract
150
+ end
151
+
152
+ class Param
153
+ def initialize(t, p)
154
+ @t = t
155
+ @p = p
156
+ end
157
+
158
+ def markdown
159
+ output = []
160
+ output << "##### `#{@t['name']}`\n"
161
+ output << "* #{@t['text']}"
162
+ output << "* Type: `#{@t['types']}`"
163
+ default = @p.defaults[@t['name']]
164
+ output << "* Default: `#{default}`" unless default.nil?
165
+ output << ''
166
+ output.join("\n")
167
+ end
168
+ end
169
+
170
+ class Example
171
+ def initialize(t, p)
172
+ @t = t
173
+ @p = p
174
+ end
175
+
176
+ def markdown
177
+ output = []
178
+ output << "##### #{@t['name']}\n"
179
+ output << "```\n#{@t['text']}\n```"
180
+ output.join("\n")
181
+ end
182
+ end
183
+ end
@@ -0,0 +1,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'puppet_readme_generator/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'puppet_readme_generator'
8
+ spec.version = PuppetReadmeGenerator::VERSION
9
+ spec.authors = ['Christian Simon']
10
+ spec.email = ['simon@swine.de']
11
+
12
+ spec.summary = 'Generate README automatically from puppet module docstrings.'
13
+ spec.description = 'Generate README automatically from puppet module docstrings.'
14
+ spec.homepage = 'https://github.com/jetstack/rubygem-puppet_readme_generator'
15
+ spec.license = 'Apache'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = 'exe'
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ['lib']
21
+
22
+ spec.add_development_dependency 'bundler', '~> 1.11'
23
+ spec.add_development_dependency 'rake', '~> 10.0'
24
+ spec.add_development_dependency 'rspec', '~> 3.0'
25
+ spec.add_dependency 'puppet-strings', '~> 1.0'
26
+ spec.add_dependency 'rake'
27
+ end
metadata ADDED
@@ -0,0 +1,129 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: puppet_readme_generator
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Christian Simon
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-03-15 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: puppet-strings
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '1.0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '1.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: Generate README automatically from puppet module docstrings.
84
+ email:
85
+ - simon@swine.de
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - lib/puppet_readme_generator.rb
101
+ - lib/puppet_readme_generator/tasks.rb
102
+ - lib/puppet_readme_generator/tasks/generate.rb
103
+ - lib/puppet_readme_generator/version.rb
104
+ - puppet_readme_generator.gemspec
105
+ homepage: https://github.com/jetstack/rubygem-puppet_readme_generator
106
+ licenses:
107
+ - Apache
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 2.5.2
126
+ signing_key:
127
+ specification_version: 4
128
+ summary: Generate README automatically from puppet module docstrings.
129
+ test_files: []