graphql-docs 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ca599041fe6ba5b75ea79e1d2bccfdb5dc435522b4bcfadffa6e1adadcdf6fb
-  data.tar.gz: a71dada7196b3871d7256e3de1aa0803fd6665ed5906ae1eead4df5ddb27714f
+  metadata.gz: 682142e3da8fc82b8239160dada35a1982156aa68455af381602619047a46a91
+  data.tar.gz: 8c819a7152b269cd0e06e8979d3dc99755e5426e1c8dd8ccdc197ffaded2fd54
 SHA512:
-  metadata.gz: 8f4511d2a9626a283421983d217e4d0b2dcb3ecf59c5fef6d029f9e2ca6a692adf08930fe2f91ebc2915975d8a1f29172d34215d8c91bf74522b40edfbe7b1e7
-  data.tar.gz: 9b04dd1b8018a68f4170ce1a4dd71e9592d4b892067043b390b6ca48d205026b9c611dc7e6b04fc297caf451a4950f80b75112d9be34c2569de5b9f17b439307
+  metadata.gz: e1749780edd31bd7baec9d97e38c6eafed30aa938eba9bc8f59a297fa4075cab18e85715427a90be631613da74fbc3a515f9545dbfc14150658d671a37e52f3e
+  data.tar.gz: 29929cab7bd7512e14f7178687d72152a4d2204a0cfdf6a1cfa1777683bdc76fafe367d0c3e385afb6d6fb64ba40f4c60be02d97fe4ee5b3cade092fe719c2b4

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Do x
+2. Do y
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
+
+Examples:
+
+- Source code
+- Version of gem being used
+- Ruby version

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/tests.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [3.1.2, 3.0.4, 2.7.6, 2.6.10]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run the test suite
+      run: bundle exec rake

data/.gitignore

@@ -12,3 +12,4 @@
 /.sass-cache/
 /output/
 .byebug_history
+*.gem

data/.rubocop.yml

@@ -1,6 +1,4 @@
-inherit_gem:
-  rubocop-standard:
-    - config/default.yml
+require: rubocop-performance
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# graphql-docs Changelog
+
+A concise overview of the public-facing changes to the gem from version to version. Does not include internal changes to the dev experience for the gem.
+
+## Unreleased
+
+## v4.0.0 - 2023-01-26
+
+- **Breaking change**: drop support for Ruby 2.5 and earlier
+- CLI with limited options, e.g. `graphql-docs schema.graphql`
+- Dart Sass replaces Ruby Sass because Ruby Sass is deprecated
+- Fixes:
+  - Upgrade commonmarker to latest ver to address security vulnerabilities
+  - commonmarker pinned to version without security vulnerability
+- Chores
+  - Dev env refresh
+
+## v3.0.1 - 2022-10-14
+
+- fix: Relieves `EscapeUtils.escape_html is deprecated. Use GCI.escapeHTML instead, it's faster` deprecation warning until it gets released in an downstream dependency
+- meta: Maintainership change from [gjtorikian](https://github.com/gjtorikian) to [brettchalupa](https://github.com/brettchalupa)
+
+## v3.0.0 - 2022-03-23
+
+- Upgrades `graphql` gem to the 2.x series

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at brettchalupa@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contribuing Guide
+
+Contributions to this project are welcome. If you have an idea for a bigger change, [open an issue first](https://github.com/brettchalupa/graphql-docs/issues/new/choose) and we can discuss it.
+
+For fixes and small additions, follow the steps below to get developing and contributing:
+
+1. Fork & clone the repository in GitHub
+2. Run the `bin/setup` script to install development dependencies
+3. Work on a branch
+4. Make changes
+5. Ensure tests pass by running `bin/rake`
+6. Commit your changes, this project follows [the Conventional Commits spec](https://www.conventionalcommits.org/en/v1.0.0/)
+7. Open up a pull request
+
+## Finding Issues
+
+- Good First Issue — If you're new to the project or Ruby, check out the ["good first issue" tag](https://github.com/brettchalupa/graphql-docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). They're smaller, approachable issues if you're just getting started.
+- Web — tasks that don't require much Ruby knowledge but require HTML and CSS have the ["web" tag](https://github.com/brettchalupa/graphql-docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22web%22+)

data/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright (c) 2017 Garen Torikian
+Copyright (c) 2022 Brett Chalupa
 
 MIT License
 

data/README.md

@@ -1,27 +1,27 @@
 # GraphQLDocs
 
-Easily generate beautiful documentation from your GraphQL schema.
+Ruby library and CLI for easily generating beautiful documentation from your GraphQL schema.
 
 ![sample](https://cloud.githubusercontent.com/assets/64050/23438604/6a23add0-fdc7-11e6-8852-ef41e8451033.png)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the gem to your project with this command:
 
-```ruby
-gem 'graphql-docs'
+``` console
+bundle add graphql-docs
 ```
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
-    $ gem install graphql-docs
+``` console
+gem install graphql-docs
+```
 
 ## Usage
 
+GraphQLDocs can be used as a Ruby library to build the documentation website. Using it as a Ruby library allows for more control and using every supported option. Here's an example:
+
 ``` ruby
 # pass in a filename
 GraphQLDocs.build(filename: filename)
@@ -36,6 +36,20 @@ end
 GraphQLDocs.build(schema: schema)
 ```
 
+GrophQLDocs also has a simplified CLI (`graphql-docs`) that gets installed with the gem:
+
+``` console
+graphql-docs schema.graphql
+```
+
+That will generate the output in the `output` dir.
+
+See all of the supported CLI options with:
+
+``` console
+graphql-docs -h
+```
+
 ## Breakdown
 
 There are several phases going on the single `GraphQLDocs.build` call:
@@ -181,16 +195,48 @@ The format of `schema_member_path` is a dot delimited path to the schema member.
 "Mutation.addLike" # a mutation
 ```
 
+## Supported Ruby Versions
+
+The gem currently supports **Ruby 2.6 and newer**. Any dropping of Ruby version
+support is considered a breaking change and means a major release for the gem.
+
+## Upgrading
+
+This project aims to strictly follow [Semantic Versioning](https://semver.org/).
+Minor and patch level updates can be done with pretty high confidence that your usage won't break.
+
+Review the
+[Changelog](https://github.com/brettchalupa/graphql-docs/blob/main/CHANGELOG.md)
+for detailed changes for each release. The intent is to make upgrading as
+painless as possible.
+
+## Roadmap
+
+Upcoming work for the project is organized publicly via [GitHub
+Projects](https://github.com/users/brettchalupa/projects/7/views/1).
+
 ## Development
 
-After checking out the repo, run `script/bootstrap` to install dependencies. Then, run `rake test` to run the tests. You can also run `bundle exec rake console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/rake test` to run the tests. You can also run `bin/console` for
+an interactive prompt that will allow you to experiment.
 
-## Sample site
+## Sample Site
 
 Clone this repository and run:
 
 ```
-bundle exec rake sample
+bin/rake sample:generate
 ```
 
-to see some sample output.
+to see some sample output in the `output` dir.
+
+Boot up a server to view it:
+
+```
+bin/rake sample:serve
+```
+
+## Credits
+
+Originally built by [gjtorikian](https://github.com/gjtorikian). Actively maintained by [brettchalupa](https://github.com/brettchalupa).

data/Rakefile

@@ -28,7 +28,6 @@ end
 
 desc 'Set up a console'
 task :console do
-  require 'pry'
   require 'graphql-docs'
 
   def reload!
@@ -36,33 +35,36 @@ task :console do
     files.each { |file| load file }
   end
 
+  require 'irb'
   ARGV.clear
-  Pry.start
+  IRB.start
 end
 
-desc 'Generate the documentation'
-task :generate_sample do
-  require 'pry'
-  require 'graphql-docs'
-
-  options = {}
-  options[:delete_output] = true
-  options[:base_url] = ENV.fetch('GQL_DOCS_BASE_URL', '')
-  options[:filename] = File.join(File.dirname(__FILE__), 'test', 'graphql-docs', 'fixtures', 'gh-schema.graphql')
-
-  GraphQLDocs.build(options)
-end
+namespace :sample do
+  desc 'Generate the sample documentation'
+  task :generate do
+    require 'graphql-docs'
 
-desc 'Generate the documentation and run a web server'
-task sample: [:generate_sample] do
-  require 'webrick'
+    options = {}
+    options[:delete_output] = true
+    options[:base_url] = ENV.fetch('GQL_DOCS_BASE_URL', '')
+    options[:filename] = File.join(File.dirname(__FILE__), 'test', 'graphql-docs', 'fixtures', 'gh-schema.graphql')
 
-  puts 'Navigate to http://localhost:3000 to see the sample docs'
+    puts "Generating sample docs"
+    GraphQLDocs.build(options)
+  end
 
-  server = WEBrick::HTTPServer.new Port: 3000
-  server.mount '/', WEBrick::HTTPServlet::FileHandler, 'output'
-  trap('INT') { server.stop }
-  server.start
+  desc 'Generate the documentation and run a web server'
+  task serve: [:generate] do
+    require 'webrick'
+    PORT = "5050"
+    puts "Navigate to http://localhost:#{PORT} to view the sample docs"
+    server = WEBrick::HTTPServer.new Port: PORT
+    server.mount '/', WEBrick::HTTPServlet::FileHandler, 'output'
+    trap('INT') { server.stop }
+    server.start
+  end
+  task server: :serve
 end
 
 desc 'Generate and publish docs to gh-pages'

data/{script → bin}/console

@@ -2,10 +2,8 @@
 
 set -e
 
-dir=`pwd`
-
 echo "===> Bundling..."
-script/bootstrap --quiet
+bin/setup --quiet
 
 echo "===> Launching..."
-bundle exec rake console
+bin/rake console

data/bin/rake

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install "$@"

data/exe/graphql-docs

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require "graphql-docs"
+require "optparse"
+
+NAME = "graphql-docs".freeze
+
+opts = {}
+OptionParser.new do |parser|
+  parser.program_name = NAME
+  parser.banner = <<~EOS
+
+  Generate GraphQL docs from the passed in schema file.
+
+  Usage: graphql-docs SCHEMA
+
+  The only required argument is the path to the schema file to generate the site from.
+
+  Examples:
+    $ graphql-docs schema.graphql
+    $ graphql-docs schema.graphql -o _docs
+
+  Options:
+  EOS
+
+  parser.version = GraphQLDocs::VERSION
+
+  parser.on("-o", "--output-dir DIR", "Where the site is generated to, defaults to ./output")
+  parser.on("-d", "--delete-output", "Delete the output-dir before generating, defaults to false")
+  parser.on("-b", "--base-url URL", "URL to preprend for assets and links, defaults to \"\"")
+  parser.on("--verbose", "Run in verbose mode")
+end.parse!(into: opts)
+
+def err(msg)
+  abort("#{NAME}: Error: #{msg}")
+end
+
+schema = ARGV[0]
+if schema.nil?
+  err("schema must be specified")
+end
+opts[:filename] = schema
+
+verbose = opts.delete(:verbose)
+
+puts("Generating site with the following options: #{opts}") if verbose
+
+opts.transform_keys! { |k| k.to_s.gsub("-", "_").to_sym }
+GraphQLDocs.build(opts)
+
+puts("Site successfully generated in: #{opts[:output_dir] || 'output' }") if verbose

data/graphql-docs.gemspec

@@ -7,38 +7,50 @@ require 'graphql-docs/version'
 Gem::Specification.new do |spec|
   spec.name          = 'graphql-docs'
   spec.version       = GraphQLDocs::VERSION
-  spec.authors       = ['Garen Torikian']
-  spec.email         = ['gjtorikian@gmail.com']
+  spec.authors       = ['Brett Chalupa', 'Garen Torikian']
+  spec.email         = ['brettchalupa@gmail.com']
 
   spec.summary       = 'Easily generate beautiful documentation from your GraphQL schema.'
-  spec.homepage      = 'https://github.com/gjtorikian/graphql-docs'
+  spec.description   = <<-EOF
+    Library and CLI for generating a website from a GraphQL API's schema
+    definition. With ERB templating support and a plethora of configuration
+    options, you can customize the output to your needs. The library easily
+    integrates with your Ruby deployment toolchain to ensure the docs for your
+    API are up to date.
+  EOF
+  spec.homepage      = 'https://github.com/brettchalupa/graphql-docs'
   spec.license       = 'MIT'
+  spec.metadata      = {
+    "bug_tracker_uri"   => "https://github.com/brettchalupa/graphql-docs/issues",
+    "changelog_uri"     => "https://github.com/brettchalupa/graphql-docs/blob/main/CHANGELOG.md",
+    "wiki_uri"          => "https://github.com/brettchalupa/graphql-docs/wiki",
+  }
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.6.0'
+
   spec.add_dependency 'graphql', '~> 2.0'
 
   # rendering
-  spec.add_dependency 'commonmarker', '~> 0.16'
+  spec.add_dependency 'commonmarker', '>= 0.23.6', '~> 0.23'
   spec.add_dependency 'escape_utils', '~> 1.2'
   spec.add_dependency 'extended-markdown-filter', '~> 0.4'
   spec.add_dependency 'gemoji', '~> 3.0'
-  spec.add_dependency 'html-pipeline', '~> 2.9'
-  spec.add_dependency 'sass', '~> 3.4'
+  spec.add_dependency 'html-pipeline', '>= 2.14.3', '~> 2.14'
+  spec.add_dependency 'dartsass', '~> 1.49'
 
-  spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'html-proofer', '~> 3.4'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-focus', '~> 1.1'
-  spec.add_development_dependency 'pry-byebug', '~> 3.6'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-performance'
-  spec.add_development_dependency 'rubocop-standard'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.37'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.15'
   spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'webrick', '~> 1.7'
 end

data/lib/graphql-docs/generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'erb'
-require 'sass'
+require 'fileutils'
 
 module GraphQLDocs
   class Generator
@@ -85,7 +85,7 @@ module GraphQLDocs
         FileUtils.mkdir_p(File.join(@options[:output_dir], 'assets'))
 
         sass = File.join(assets_dir, 'css', 'screen.scss')
-        system `sass --sourcemap=none #{sass}:#{@options[:output_dir]}/assets/style.css`
+        system `bundle exec dartsass --no-source-map=none #{sass} #{@options[:output_dir]}/assets/style.css`
 
         FileUtils.cp_r(File.join(assets_dir, 'images'), File.join(@options[:output_dir], 'assets'))
         FileUtils.cp_r(File.join(assets_dir, 'webfonts'), File.join(@options[:output_dir], 'assets'))

data/lib/graphql-docs/layouts/default.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="utf-8">
     <meta name="description" content="<%= name %> GraphQL documentation">
-    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
     <title><%= title || name %></title>
     <link rel="stylesheet" href="<%= base_url %>/assets/style.css">
     <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.2.2/anchor.min.js"></script>

data/lib/graphql-docs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphQLDocs
-  VERSION = '3.0.0'
+  VERSION = '4.0.0'
 end

data/lib/graphql-docs.rb

@@ -7,10 +7,6 @@ require 'graphql-docs/generator'
 require 'graphql-docs/parser'
 require 'graphql-docs/version'
 
-begin
-  require 'awesome_print'
-  require 'pry'
-rescue LoadError; end # rubocop:disable Lint/SuppressedException
 module GraphQLDocs
   class << self
     def build(options)

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
+- Brett Chalupa
 - Garen Torikian
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -28,16 +29,22 @@ dependencies:
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.6
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.23.6
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: escape_utils
   requirement: !ruby/object:Gem::Requirement
@@ -84,44 +91,36 @@ dependencies:
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: dartsass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.49'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  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'
+        version: '1.49'
 - !ruby/object:Gem::Dependency
   name: html-proofer
   requirement: !ruby/object:Gem::Requirement
@@ -165,104 +164,104 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.37'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.37'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rubocop-standard
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-description:
+        version: '1.7'
+description: |2
+      Library and CLI for generating a website from a GraphQL API's schema
+      definition. With ERB templating support and a plethora of configuration
+      options, you can customize the output to your needs. The library easily
+      integrates with your Ruby deployment toolchain to ensure the docs for your
+      API are up to date.
 email:
-- gjtorikian@gmail.com
-executables: []
+- brettchalupa@gmail.com
+executables:
+- graphql-docs
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- exe/graphql-docs
 - graphql-docs.gemspec
 - lib/graphql-docs.rb
 - lib/graphql-docs/configuration.rb
@@ -334,12 +333,13 @@ files:
 - lib/graphql-docs/parser.rb
 - lib/graphql-docs/renderer.rb
 - lib/graphql-docs/version.rb
-- script/bootstrap
-- script/console
-homepage: https://github.com/gjtorikian/graphql-docs
+homepage: https://github.com/brettchalupa/graphql-docs
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/brettchalupa/graphql-docs/issues
+  changelog_uri: https://github.com/brettchalupa/graphql-docs/blob/main/CHANGELOG.md
+  wiki_uri: https://github.com/brettchalupa/graphql-docs/wiki
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -348,14 +348,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Easily generate beautiful documentation from your GraphQL schema.

data/.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: gjtorikian
-patreon: gjtorikian
-open_collective: garen-torikian
-#ko_fi: # Replace with a single Ko-fi username
-#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-#liberapay: # Replace with a single Liberapay username
-issuehunt: gjtorikian
-#otechie: # Replace with a single Otechie username
-#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.travis.yml

@@ -1,23 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
-
-git:
-  depth: 10
-
-before_install:
-  - gem update --system
-  - gem install bundler
-
-matrix:
-  include:
-    - script: bundle exec rake rubocop
-      rvm: 2.6.0
-    - script: bundle exec rake html_proofer
-      rvm: 2.6.0

data/script/bootstrap

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -e
-
-bundle install "$@"