ansible_doc_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92c4b9b336f51128976073f25628e2f80418614fdd604228e06a8bb18e125646
+  data.tar.gz: 94e8389fc7029102b5e59c083b6412c74a022e54b103005d53a2932fd13396d6
+SHA512:
+  metadata.gz: bcadf49014d4611a31971946f94245a39c133cb01daa486d931423a15502cbec776c1fe6a36da8900de4d95cfd55c20d6207857444b44bdcca27b847b368b35e
+  data.tar.gz: ff39c855e475d173ef69062ffc0483c7aff9976d14d600ae4f2f0f1876b5ccd0d65f437bd15ab4d126f9c698561882dd760922a4aac8da796ea5ab8c5450982e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*gem
+.ruby-version

data/.rspec

@@ -0,0 +1 @@
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at krzysztof.maicher@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
+

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pg_export.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Populate Tools SL
+
+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,107 @@
+# ansible-doc-generator
+
+CLI for documenting Ansible roles into Markdown files.
+
+Documentation is generated from _magic_ comments declared in the tasks file of a role, where everycomment should be put before the declaration of the task.
+
+These are the types of comments accepted:
+
+- `@metatitle` defines a high level title (equivalent to h2). It's expected to be just one metatitle per role
+- `@title` defines the title of the role or the title of the step (it's flexible)
+- `@comment` completes the information provided by the title. This comment allows multiple lines and multiple instances
+- `@input` defines the command or action executed by the task. Produces a block of code. This comment is also multiline
+- `@output` defines the result of the execution. Produces a block of code
+
+Comments allow variable interpolation with the syntax `#{var}`. If the variable is defined in a
+sub-level it can be reached using the `>` operator, i.e. `#{apt>pkg}`
+
+Here's an example of role that uses most of the comments and variable interpolation:
+
+```yaml
+---
+# @metatitle Install Postgresql
+
+# @input wget --quiet -O - #{apt_key>url} | sudo apt-key add -
+- name: Add APT key
+  become: true
+  apt_key:
+    url: "https://www.postgresql.org/media/keys/ACCC4CF8.asc"
+    state: present
+
+# @title Add repository
+# @input sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" >> /etc/apt/sources.list.d/pgdg.list'
+- name: Add APT postgres repository
+  become: true
+  apt_repository:
+    repo: deb http://apt.postgresql.org/pub/repos/apt/ {{ansible_distribution_release}}-pgdg main
+    state: present
+    filename: 'pgdg.list'
+
+# @title Install #{apt>pkg} packages
+# @input apt install -y #{apt>pkg | join: ' '}
+- name: Install Postgres
+  become: true
+  apt:
+    pkg: ['postgresql-12', 'postgresql-server-dev-12', 'postgresql-contrib-12']
+    state: present
+    update_cache: yes
+
+# @title Install PostGis 3
+# @input apt install -y #{apt>pkg | join: ' '}
+- name: Install PostGis
+  become: true
+  apt:
+    pkg: postgresql-12-postgis-3
+    state: present
+```
+
+## Other features
+
+### Localization
+
+`@metatitle`, `@title` and `@comment` support localization, by adding at the end of the label the locale code, i.e.:
+
+```
+# @title_es Instalar Ruby
+# @title_en Install Ruby
+# @comment_es Este rol instala Ruby utilizando Rbenv.
+# @comment_en This role installs Ruby using Rbenv
+```
+
+When calling the generation, you'll need to add a second parameter with the locale you want to
+generate:
+
+```
+$ ansible-doc-generator ~/ansible/playbooks/ruby.yml es # to generate Spanish documentation
+```
+
+## Installation
+
+```
+$ gem install ansible-doc-generator
+```
+
+## TODO
+
+- [ ] Provide an example of documented repository
+- [ ] better error reporting
+- [ ] support includes
+- [ ] deal with conditions
+
+For a more complete list review the repository issues.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PopulateTools/ansible-doc-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Authors
+
+This is a project developed by [Populate](https://populate.tools) team to document our Ansible roles and provide a great documentation to our customers.

data/ansible_doc_generator.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ansible_doc_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ansible_doc_generator'
+  spec.version       = AnsibleDocGenerator::VERSION
+  spec.authors       = ['Víctor Martín', 'Fernando Blat']
+  spec.email         = ['victor@populate.tools', 'fernando@populate.tools']
+
+  spec.summary       = 'Document Ansible roles'
+  spec.description   = "CLI for generating documentation of Ansible roles \
+                        based on a markup language in their comments"
+  spec.homepage      = 'https://github.com/PopulateTools/ansible-doc-generator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['ansible-doc-generator']
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.59.2'
+end

data/bin/ansible-doc-generator

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require_relative '../lib/ansible_doc_generator'
+
+options = {
+  lang: 'en'
+}
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: ansible-doc-generator [options]'
+
+  opts.on("-p playbook_path", "--playbook=playbook_path", String, "Path to the playbook") do |playbook|
+    options[:playbook] = playbook
+  end
+
+  opts.on("-l es|en", "--lang=es|en", String, "Documentation language (default en)") do |lang|
+    options[:lang] = lang
+  end
+
+  opts.on('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  option_parser.parse!
+rescue OptionParser::ParseError => e
+  warn e.message.capitalize
+  warn 'Type "ansible_doc_generator -h" for available options'
+  exit
+end
+
+abort(option_parser.help) if options[:playbook].nil?
+
+# Run generator
+AnsibleDocGenerator::DocGenerator.new(options[:playbook], options[:lang]).call
+

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/ansible_doc_generator.rb

@@ -0,0 +1,8 @@
+require "yaml"
+require "pry"
+
+require_relative "ansible_doc_generator/doc_generator"
+require_relative "ansible_doc_generator/version"
+
+module AnsibleDocGenerator
+end

data/lib/ansible_doc_generator/doc_generator.rb

@@ -0,0 +1,63 @@
+require_relative "playbook_helpers"
+require_relative "doc_generator/role_doc_extractor"
+
+module AnsibleDocGenerator
+  class DocGenerator
+    include PlaybookHelpers
+
+    attr_reader :playbook_path, :lang
+    attr_accessor :md_output
+
+    def initialize playbook_path, lang
+      @playbook_path = playbook_path
+      @lang = lang
+      @md_output = []
+    end
+
+    def call
+      parse_roles
+      write_readme
+    end
+
+    private
+
+    def parse_roles
+      paths.each do |path|
+        yml_path = tasks_yml_path_for_role(path)
+        maybe_generate_doc_for_role yml_path
+      end
+    end
+
+    def write_readme
+      doc_path = File.join(project_folder, 'docs', "installation_#{lang}.md")
+
+      delete_if_exists(doc_path)
+      FileUtils.mkdir_p(File.dirname(doc_path))
+      File.open(doc_path, 'w'){|file| file.write(clean_md_output) }
+
+      puts "> Installation guide saved in #{doc_path}"
+    end
+
+    def maybe_generate_doc_for_role yml_path
+      if File.exists?(yml_path)
+        puts "+ Generating doc for: #{yml_path}"
+        generate_doc_for_role yml_path
+      else
+        puts "- main.yml not found in path #{yml_path}"
+      end
+    end
+
+    def generate_doc_for_role yml_path
+      md_output << RoleDocExtractor.new(yml_path, lang).call
+    end
+
+    def clean_md_output
+      md_output.reject{|line| line.strip == '' || line.nil? }.join("\n\n")
+    end
+
+    def tasks_yml_path_for_role path
+      File.join(project_folder, path, 'tasks', 'main.yml')
+    end
+
+  end
+end

data/lib/ansible_doc_generator/doc_generator/interpolator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "interpolator/variable_extractor"
+require_relative "interpolator/file_extractor"
+
+module AnsibleDocGenerator
+  class DocGenerator
+    class Interpolator
+      attr_reader :input, :task, :role_path
+
+      def initialize input, task, role_path
+        @input = input
+        @task = task
+        @role_path = role_path
+      end
+
+      def call
+        variables_interpolated = Interpolator::VariableExtractor.new(input, task, role_path).call
+        Interpolator::FileExtractor.new(variables_interpolated, role_path).call
+      end
+
+    end
+  end
+end

data/lib/ansible_doc_generator/doc_generator/interpolator/file_extractor.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module AnsibleDocGenerator
+  class DocGenerator
+    class Interpolator
+      class FileExtractor
+        attr_reader :input, :role_path
+
+        def initialize input, role_path
+          @input = input
+          @role_path = role_path
+        end
+
+        def call
+          output = input
+
+          input.scan(/f\{[^\}]+\}/).each do |interpolation|
+            file_content = get_file_content(interpolation)
+            output.gsub!(interpolation, file_content)
+          end
+
+          output
+        end
+
+        private
+
+        def get_file_content interpolation
+          file_name = interpolation.match(/f\{(\S*)\}/)[1]
+          file_path = get_file_path_from(file_name)
+
+          return interpolation if file_path.nil?
+          File.read(file_path)
+        end
+
+        def get_file_path_from file_name
+          %w(files templates)
+            .map{|folder_name| File.join(main_folder, folder_name, file_name) }
+            .find{|file_path| File.exists?(file_path) }
+        end
+
+        def main_folder
+          @main_folder ||= File.expand_path("..", File.dirname(role_path))
+        end
+
+      end
+    end
+  end
+end

data/lib/ansible_doc_generator/doc_generator/interpolator/variable_extractor.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module AnsibleDocGenerator
+  class DocGenerator
+    class Interpolator
+      class VariableExtractor
+
+        class MissingInterpolationError < StandardError; end
+
+        attr_reader :input, :task, :role_path
+
+        def initialize input, task, role_path
+          @input = input
+          @task = task
+          @role_path = role_path
+          @filters = {
+            join: ', '
+          }
+        end
+
+        def call
+          output = input
+
+          input.scan(/#\{[^\}]+\}/).each do |interpolation|
+            new_string = get_string(interpolation)
+            output.gsub!(interpolation, new_string)
+          end
+
+          output
+        end
+
+        private
+
+        def get_string interpolation
+          variable_match = interpolation.match(/#\{([^\}]+)\}/)[1]
+          yaml_path, filters = variable_match.split('|')
+          set_filters(filters)
+          yaml_value = dig(task, yaml_path.gsub(/\s/, '').split('>'))
+
+          case yaml_value
+          when String then yaml_value
+          when Array then yaml_value.join(@filters[:join])
+          else interpolation
+          end
+        rescue MissingInterpolationError => e
+          raise e, "Interpolation not found:\n - #{interpolation}\n - #{task}\n - #{role_path}"
+        end
+
+        def set_filters(filters)
+          return if filters.nil?
+          filter_name, filter_value = filters.split(':')
+          @filters[filter_name.gsub(/\s/, '').to_sym] = eval(filter_value)
+        end
+
+        def dig task, keys
+          head, *tail = keys
+          new_task = task[head]
+
+          raise MissingInterpolationError if new_task.nil?
+
+          if tail == []
+            return new_task
+          elsif new_task.is_a?(String) && tail != []
+            return scan_in_inline_syntax(new_task, tail.first)
+          else
+            dig(new_task, tail)
+          end
+        end
+
+        def scan_in_inline_syntax string, key
+          input = StringScanner.new(string)
+
+          # Scan until the key we are looking for
+          input.scan_until(/#{key}=/)
+          # Scan until the next key or until the end
+          output = input.scan_until(/\s{1}\S+=/) || input.scan(/.*/)
+          # Remove the next key part
+          output.gsub(/\s{1}\S+=/, '')
+        end
+
+      end
+    end
+  end
+end

data/lib/ansible_doc_generator/doc_generator/role_doc_extractor.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require_relative "interpolator"
+
+module AnsibleDocGenerator
+  class DocGenerator
+    class RoleDocExtractor
+      attr_reader :yml_path, :lang
+      attr_accessor :parsed_content, :md_output
+
+      META_KEYWORDS = %w(metatitle)
+
+      def initialize yml_path, lang
+        @yml_path = yml_path
+        @lang = lang
+        @parsed_content = {'meta' => []}
+        @md_output = []
+      end
+
+      def call
+        joined_output
+      end
+
+      private
+
+      def joined_output
+        @joined_output ||= begin
+          parse_file_comments
+          generate_meta_content
+          generate_tasks_content
+
+          join_elements(md_output, "\n\n")
+        end
+      end
+
+      # Extract relevant lines from the file and group them by task
+      def parse_file_comments
+        file = File.open(yml_path)
+        current_comments = []
+        file.each do |line|
+          if line.start_with?('#') && META_KEYWORDS.any?{|keyword| line.start_with?("# @#{keyword}") }
+            parsed_content['meta'] << line.gsub('# ', '').strip
+          elsif line.start_with?('#')
+            current_comments << line.gsub(/\A#\s{1}/, '')
+          elsif line.start_with?('- name:')
+            task_name = line.gsub('- name:','').strip
+            parsed_content[task_name] = current_comments
+            current_comments = []
+          end
+        end and nil
+        file.close
+      end
+
+      def generate_meta_content
+        return if parsed_content['meta'] == []
+        metatitle = extract_from(:metatitle, parsed_content['meta'])
+        return if metatitle.nil?
+
+        md_output << "## #{metatitle}"
+      end
+
+      # Parse previously extracted lines and separated them by keyword
+      def generate_tasks_content
+        parsed_content.each do |task_name, lines|
+          title = extract_from(:title, lines)
+
+          output = extract_multiline_from(:output, lines, separator: "\n")
+          input = extract_multiline_from(:input, lines, separator: "\n")
+          comments = extract_multiline_from(:comment, lines)
+
+          md_output << generate_md_with(task_name, title: title, comments: comments, output: output, input: input)
+        end
+      end
+
+      def generate_md_with task_name, params
+        temp_md = []
+        temp_md.push("### #{params[:title]}") if params[:title]
+        params.fetch(:comments, []).each{|comment| temp_md << comment }
+        temp_md << "```\n#{params.fetch(:input, []).join("\n")}\n```" if params[:input].length > 0
+        temp_md << "Expected output: \n\n```\n#{params[:output]}\n```" if params[:output].length > 0
+
+        non_interpolated_output = join_elements(temp_md, "\n\n")
+        task = tasks.find{|task| task['name'] == task_name}
+        Interpolator.new(non_interpolated_output, task, yml_path).call
+      end
+
+      def extract_from keyword, lines
+        line = lines.find{|line| selectable_line?(keyword, line) }
+        clean_line(keyword, line)
+      end
+
+      # - a comment, for instance, can be in several lines and only the first one will have the keyword.
+      # - if a new "@comment" appear, it's a new comment
+      # - this method always return an array, but some keywords like input or output will only use one item
+      def extract_multiline_from keyword, lines, separator: ' '
+        collection = []     # collection of @keyword with maybe several lines
+        current_item = []   # current @keyword that will change through the loop
+        current_keyword = nil
+
+        lines.each do |line|
+          # It's the beginning of a comment
+          if selectable_line?(keyword, line)
+            current_keyword = keyword
+            # we save the previous comment before parsing the new one
+            if current_item.any?
+              collection << join_elements(current_item, separator)
+              current_item = []
+            end
+            current_item << clean_line(current_keyword, line)
+          # If it's another keyword but not relevant, we store current comment. But we keep the loop in case there are others
+          elsif line.start_with?("@") && !selectable_line?(keyword, line) && current_item.any?
+            collection << join_elements(current_item, separator)
+            current_item = []
+          # It's the second/third... line of a comment
+          elsif current_item.any? && !line.start_with?('@')
+            current_item << clean_line(current_keyword, line)
+          end
+        end
+
+        collection << join_elements(current_item, separator) if current_item.any?
+
+        collection
+      end
+
+      def selectable_line?(keyword, line)
+        line.start_with?("@#{keyword}_#{lang}") || (line.start_with?("@#{keyword}") && !line.start_with?("@#{keyword}_"))
+      end
+
+      def clean_line(keyword, line)
+        return nil unless line
+
+        no_keyword_line = line.gsub(/@#{keyword}_#{lang}|@#{keyword}/, '')
+        if %w(input output).include?(keyword)
+          no_keyword_line
+        else
+          no_keyword_line.strip
+        end
+      end
+
+      def join_elements elements, separator
+        elements.reject{|line| line.strip == '' || line.nil? }.join(separator)
+      end
+
+      def tasks
+        @tasks = YAML.load_file(yml_path)
+      end
+
+    end
+  end
+end

data/lib/ansible_doc_generator/playbook_helpers.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+
+module AnsibleDocGenerator
+  module PlaybookHelpers
+
+    private
+
+    def delete_if_exists path
+      FileUtils.remove_entry(path, true)
+    end
+
+    def paths
+      @paths ||= roles.map{|role| role['role'] }
+    end
+
+    def roles
+      playbook['roles']
+    end
+
+    def project_folder
+      @project_folder ||= File.dirname(playbook_path)
+    end
+
+    def playbook
+      @playbook ||= YAML.load_file(playbook_path).first
+    end
+  end
+end

data/lib/ansible_doc_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AnsibleDocGenerator
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: ansible_doc_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Víctor Martín
+- Fernando Blat
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+description: CLI for generating documentation of Ansible roles                         based
+  on a markup language in their comments
+email:
+- victor@populate.tools
+- fernando@populate.tools
+executables:
+- ansible-doc-generator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- ansible_doc_generator.gemspec
+- bin/ansible-doc-generator
+- bin/setup
+- lib/ansible_doc_generator.rb
+- lib/ansible_doc_generator/doc_generator.rb
+- lib/ansible_doc_generator/doc_generator/interpolator.rb
+- lib/ansible_doc_generator/doc_generator/interpolator/file_extractor.rb
+- lib/ansible_doc_generator/doc_generator/interpolator/variable_extractor.rb
+- lib/ansible_doc_generator/doc_generator/role_doc_extractor.rb
+- lib/ansible_doc_generator/playbook_helpers.rb
+- lib/ansible_doc_generator/version.rb
+homepage: https://github.com/PopulateTools/ansible-doc-generator
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Document Ansible roles
+test_files: []