puppet_readme_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e785cee37db01e0ea247e8fee2f9c3bd28918864
+  data.tar.gz: 925b80d0a901a692e194ba5c839c442269e250cf
+SHA512:
+  metadata.gz: 7e11e592e70ca62e79e7b7603eb7ed350ca734c2cd9e12a1c1fe7d834a2b97c4ea0fe32f61e7b66b9f2594fe90cf0eaf1d5b29ab6deb8b759a8a9e1c2d506de1
+  data.tar.gz: 67d437f96e5fbdc0cb7090c1642c7b65853eb0b9af0aad95558971a620a2129792c6e214f3c851be4739a7ac76668547ae599bf65fc3f95f53048d31223fd575

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at simon@swine.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puppet_readme_generator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Christian Simon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# PuppetReadmeGenerator

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'puppet_readme_generator'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/puppet_readme_generator/tasks/generate.rb

@@ -0,0 +1,12 @@
+require 'puppet_readme_generator'
+
+# Implements the strings:generate task.
+namespace :readme do
+  desc 'Generate a README.md for this Puppet module'
+  task :generate do
+    g = PuppetReadmeGenerator::Generator.new
+    open('README.md', 'w') do |f|
+      f.puts g.markdown
+    end
+  end
+end

data/lib/puppet_readme_generator/tasks.rb

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/tasklib'
+
+module PuppetReadmeGenerator
+  module Tasks
+    require 'puppet_readme_generator/tasks/generate.rb'
+  end
+end

data/lib/puppet_readme_generator/version.rb

@@ -0,0 +1,3 @@
+module PuppetReadmeGenerator
+  VERSION = '0.1.0'.freeze
+end

data/lib/puppet_readme_generator.rb

@@ -0,0 +1,183 @@
+require 'puppet_readme_generator/version'
+require 'puppet-strings'
+require 'json'
+
+module PuppetReadmeGenerator
+  class Generator
+    def initialize
+      patterns ||= PuppetStrings::DEFAULT_SEARCH_PATTERNS
+      options = {}
+      options[:json] = 'documentation.json'
+      PuppetStrings.generate(patterns, options)
+    end
+
+    def markdown
+      output = []
+      output << "# #{puppet_module}\n"
+      output << "#### Table of Contents\n"
+      output << '1. [Description](#description)'
+      output << '2. [Classes](#classes)'
+      output << '3. [Defined Types](#defined-types)'
+
+      output << '## Description'
+      output << main_class.text
+      output << ''
+
+      output << '## Classes'
+      classes.each do |c|
+        output << ''
+        output << c.markdown
+      end
+
+      output << '## DefinedTypes'
+      defined_types.each do |dt|
+        output << ''
+        output << dt.markdown
+      end
+
+      output.join("\n")
+    end
+
+    def documentation_path
+      'documentation.json'
+    end
+
+    def documentation
+      @documentation ||= JSON.parse(File.open(documentation_path).read)
+    end
+
+    def metadata_path
+      'metadata.json'
+    end
+
+    def metadata
+      @metadata ||= JSON.parse(File.open(metadata_path).read)
+    end
+
+    def puppet_module
+      metadata['name'].split('-')[1]
+    end
+
+    def main_class
+      classes.each do |c|
+        return c if c.name == puppet_module
+      end
+      nil
+    end
+
+    def classes
+      if @classes.nil?
+        @classes = documentation['puppet_classes'].map do |c|
+          Class.new c
+        end
+      end
+      @classes
+    end
+
+    def defined_types
+      if @defined_types.nil?
+        @defined_types = documentation['defined_types'].map do |c|
+          DefinedType.new c
+        end
+      end
+      @defined_types
+    end
+  end
+
+  class ClassAbstract
+    def initialize(c)
+      @c = c
+    end
+
+    def name
+      @c['name']
+    end
+
+    def text
+      @c['docstring']['text']
+    end
+
+    def examples
+      if @examples.nil?
+        @examples = []
+        @c['docstring']['tags'].each do |t|
+          next unless t['tag_name'] == 'example'
+          @examples << Example.new(t, self)
+        end
+      end
+      @examples
+    end
+
+    def params
+      if @params.nil?
+        @params = []
+        @c['docstring']['tags'].each do |t|
+          next unless t['tag_name'] == 'param'
+          @params << Param.new(t, self)
+        end
+      end
+      @params
+    end
+
+    def markdown
+      output = []
+      output << "### `#{@c['name']}`\n"
+      output << text
+      output << ''
+
+      output << "#### Parameters\n"
+      params.each do |p|
+        output << p.markdown
+      end
+
+      output << "#### Examples\n"
+      examples.each do |e|
+        output << e.markdown
+      end
+
+      output.join("\n")
+    end
+
+    def defaults
+      @c['defaults']
+    end
+  end
+
+  class Class < ClassAbstract
+  end
+
+  class DefinedType < ClassAbstract
+  end
+
+  class Param
+    def initialize(t, p)
+      @t = t
+      @p = p
+    end
+
+    def markdown
+      output = []
+      output << "##### `#{@t['name']}`\n"
+      output << "* #{@t['text']}"
+      output << "* Type: `#{@t['types']}`"
+      default = @p.defaults[@t['name']]
+      output << "* Default: `#{default}`" unless default.nil?
+      output << ''
+      output.join("\n")
+    end
+  end
+
+  class Example
+    def initialize(t, p)
+      @t = t
+      @p = p
+    end
+
+    def markdown
+      output = []
+      output << "##### #{@t['name']}\n"
+      output << "```\n#{@t['text']}\n```"
+      output.join("\n")
+    end
+  end
+end

data/puppet_readme_generator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppet_readme_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'puppet_readme_generator'
+  spec.version       = PuppetReadmeGenerator::VERSION
+  spec.authors       = ['Christian Simon']
+  spec.email         = ['simon@swine.de']
+
+  spec.summary       = 'Generate README automatically from puppet module docstrings.'
+  spec.description   = 'Generate README automatically from puppet module docstrings.'
+  spec.homepage      = 'https://github.com/jetstack/rubygem-puppet_readme_generator'
+  spec.license       = 'Apache'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'puppet-strings', '~> 1.0'
+  spec.add_dependency 'rake'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: puppet_readme_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Simon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: puppet-strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate README automatically from puppet module docstrings.
+email:
+- simon@swine.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puppet_readme_generator.rb
+- lib/puppet_readme_generator/tasks.rb
+- lib/puppet_readme_generator/tasks/generate.rb
+- lib/puppet_readme_generator/version.rb
+- puppet_readme_generator.gemspec
+homepage: https://github.com/jetstack/rubygem-puppet_readme_generator
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Generate README automatically from puppet module docstrings.
+test_files: []