graphql-docs 3.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99086c3e1811e349aa9ea5cec00715e8d4809ed3645a7b4ca6867a945958ad9b
-  data.tar.gz: e46166af01f325dd73dd6f328c070c8d23437fc6e4e8734b22d4607462b9eea6
+  metadata.gz: cbf28a678c378ebc2d54f6e5b7b24a05bd3eb577f144b9042fe11c4e7f34bd13
+  data.tar.gz: 993ad8805892c0544128baabec9dfd4f5bfb1cf16fccbe5cc43c3373036fcbbd
 SHA512:
-  metadata.gz: c464e56c73fc3ffdd31a89a1793e3c3fdb3014766f05d6ea4d95bcf158302a0a506b2278fd36f4994660b92f38dd8769cc1901c343ddda5bddb41714a593ad56
-  data.tar.gz: 3ca5e79abb61fa954695ea37c4368bbcfcf43ca5a3269bd800ea3595abcbde686a4006978393d192a9d862a9dfd72a25e320a818433c77fdfcbb04483d0d21ac
+  metadata.gz: 94e80febfa9d2c367182afd21b6a0d3e1206ec3d076a6b774ecfb96308648e4e582e818d1ac4f0b0734aaad514e46edac8a50f9ecb6baddf1370790e5eee7f38
+  data.tar.gz: 549077a6761dd67e983ab2c6bb402d5d67cfecafde214ddc57a7580439012eeb6a68ae6f0ff2091076d56eb64449aae9c055d87dc6e8a9da3fec081f51806d76

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

@@ -1,6 +1,6 @@
 name: Ruby
 
-on: [push,pull_request]
+on: [push, pull_request]
 
 jobs:
   test:
@@ -8,14 +8,14 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [3.1.2, 3.0.4, 2.7.6, 2.6.10, 2.5.9]
+        ruby-version: [3.3, 3.2, 3.1]
 
     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
+      - 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

@@ -2,11 +2,33 @@
 
 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.
 
-## v3.0.1
+## Unreleased
+
+## v5.0.0 - 2024-07-03
+
+- **breaking**: The graphql gem 2.2.0+ breaks some of the parsing and displaying of comments from a GraphQL schema file
+- **breaking**: Ruby 2.6, 2.7, 3.0 are no longer supported as they are End of Life (EOL)
+- feat: CLI version flag: `graphql-docs --version` / `graphql-docs -v`
+- fix: CLI now works outside of a Bundler project
+- fix: test suite
+- chore: switch to sess-embedded gem for more maintained dependency
+
+## 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
+## 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/README.md

@@ -1,28 +1,28 @@
 # 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
 
-``` ruby
+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,18 +36,32 @@ end
 GraphQLDocs.build(schema: schema)
 ```
 
+GraphQLDocs 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:
 
-* The GraphQL IDL file is read (if you passed `filename`) through `GraphQL::Client` (or simply read if you passed a string through `schema`).
-* `GraphQL::Parser` manipulates the IDL into a slightly saner format.
-* `GraphQL::Generator` takes that saner format and begins the process of applying items to the HTML templates.
-* `GraphQL::Renderer` technically runs as part of the generation phase. It passes the contents of each page and converts it into HTML.
+- The GraphQL IDL file is read (if you passed `filename`) through `GraphQL::Client` (or simply read if you passed a string through `schema`).
+- `GraphQL::Parser` manipulates the IDL into a slightly saner format.
+- `GraphQL::Generator` takes that saner format and begins the process of applying items to the HTML templates.
+- `GraphQL::Renderer` technically runs as part of the generation phase. It passes the contents of each page and converts it into HTML.
 
 If you wanted to, you could break these calls up individually. For example:
 
-``` ruby
+```ruby
 options = {}
 options[:filename] = "#{File.dirname(__FILE__)}/../data/graphql/schema.idl"
 options[:renderer] = MySuperCoolRenderer
@@ -66,14 +80,14 @@ generator.generate
 
 ## Generating output
 
-By default, the HTML generation process uses ERB to layout the content. There are a bunch of default options provided for you, but feel free to override any of these. The *Configuration* section below has more information on what you can change.
+By default, the HTML generation process uses ERB to layout the content. There are a bunch of default options provided for you, but feel free to override any of these. The _Configuration_ section below has more information on what you can change.
 
 It also uses [html-pipeline](https://github.com/jch/html-pipeline) to perform the rendering by default. You can override this by providing a custom rendering class.You must implement two methods:
 
-* `initialize` - Takes two arguments, the parsed `schema` and the configuration `options`.
-* `render` Takes the contents of a template page. It also takes two optional kwargs, the GraphQL `type` and its `name`. For example:
+- `initialize` - Takes two arguments, the parsed `schema` and the configuration `options`.
+- `render` Takes the contents of a template page. It also takes two optional kwargs, the GraphQL `type` and its `name`. For example:
 
-``` ruby
+```ruby
 class CustomRenderer
   def initialize(parsed_schema, options)
     @parsed_schema = parsed_schema
@@ -106,10 +120,10 @@ If you want to add additional variables for your landing pages, you can add defi
 
 In your ERB layouts, there are several helper methods you can use. The helper methods are:
 
-* `slugify(str)` - This slugifies the given string.
-* `include(filename, opts)` - This embeds a template from your `includes` folder, passing along the local options provided.
-* `markdownify(string)` - This converts a string into HTML via CommonMarker.
-* `graphql_operation_types`, `graphql_mutation_types`, `graphql_object_types`, `graphql_interface_types`, `graphql_enum_types`, `graphql_union_types`, `graphql_input_object_types`, `graphql_scalar_types`, `graphql_directive_types` - Collections of the various GraphQL types.
+- `slugify(str)` - This slugifies the given string.
+- `include(filename, opts)` - This embeds a template from your `includes` folder, passing along the local options provided.
+- `markdownify(string)` - This converts a string into HTML via CommonMarker.
+- `graphql_operation_types`, `graphql_mutation_types`, `graphql_object_types`, `graphql_interface_types`, `graphql_enum_types`, `graphql_union_types`, `graphql_input_object_types`, `graphql_scalar_types`, `graphql_directive_types` - Collections of the various GraphQL types.
 
 To call these methods within templates, you must use the dot notation, such as `<%= slugify.(text) %>`.
 
@@ -117,20 +131,20 @@ To call these methods within templates, you must use the dot notation, such as `
 
 The following options are available:
 
-| Option | Description | Default |
-| :----- | :---------- | :------ |
-| `filename` | The location of your schema's IDL file. | `nil` |
-| `schema` | A string representing a schema IDL file. | `nil` |
-| `output_dir` | The location of the output HTML. | `./output/` |
-| `use_default_styles` | Indicates if you want to use the default styles. | `true` |
-| `base_url` | Indicates the base URL to prepend for assets and links. | `""` |
-| `delete_output` | Deletes `output_dir` before generating content. | `false` |
-| `pipeline_config` | Defines two sub-keys, `pipeline` and `context`, which are used by `html-pipeline` when rendering your output. | `pipeline` has `ExtendedMarkdownFilter`, `EmojiFilter`, and `TableOfContentsFilter`. `context` has `gfm: false` and `asset_root` set to GitHub's CDN. |
-| `renderer` | The rendering class to use. | `GraphQLDocs::Renderer`
-| `templates` | The templates to use when generating HTML. You may override any of the following keys: `default`, `includes`, `operations`, `objects`, `mutations`, `interfaces`, `enums`, `unions`, `input_objects`, `scalars`, `directives`. | The defaults are found in _lib/graphql-docs/layouts/_.
-| `landing_pages` | The landing page to use when generating HTML for each type. You may override any of the following keys: `index`, `query`, `object`, `mutation`, `interface`, `enum`, `union`, `input_object`, `scalar`, `directive`. | The defaults are found in _lib/graphql-docs/landing\_pages/_.
-| `classes` | Additional class names you can provide to certain elements. | The full list is available in _lib/graphql-docs/configuration.rb_.
-| `notices` | A proc used to add notices to schema members. See *Customizing Notices* section below. | `nil` |
+| Option               | Description                                                                                                                                                                                                                    | Default                                                                                                                                               |
+| :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `filename`           | The location of your schema's IDL file.                                                                                                                                                                                        | `nil`                                                                                                                                                 |
+| `schema`             | A string representing a schema IDL file.                                                                                                                                                                                       | `nil`                                                                                                                                                 |
+| `output_dir`         | The location of the output HTML.                                                                                                                                                                                               | `./output/`                                                                                                                                           |
+| `use_default_styles` | Indicates if you want to use the default styles.                                                                                                                                                                               | `true`                                                                                                                                                |
+| `base_url`           | Indicates the base URL to prepend for assets and links.                                                                                                                                                                        | `""`                                                                                                                                                  |
+| `delete_output`      | Deletes `output_dir` before generating content.                                                                                                                                                                                | `false`                                                                                                                                               |
+| `pipeline_config`    | Defines two sub-keys, `pipeline` and `context`, which are used by `html-pipeline` when rendering your output.                                                                                                                  | `pipeline` has `ExtendedMarkdownFilter`, `EmojiFilter`, and `TableOfContentsFilter`. `context` has `gfm: false` and `asset_root` set to GitHub's CDN. |
+| `renderer`           | The rendering class to use.                                                                                                                                                                                                    | `GraphQLDocs::Renderer`                                                                                                                               |
+| `templates`          | The templates to use when generating HTML. You may override any of the following keys: `default`, `includes`, `operations`, `objects`, `mutations`, `interfaces`, `enums`, `unions`, `input_objects`, `scalars`, `directives`. | The defaults are found in _lib/graphql-docs/layouts/_.                                                                                                |
+| `landing_pages`      | The landing page to use when generating HTML for each type. You may override any of the following keys: `index`, `query`, `object`, `mutation`, `interface`, `enum`, `union`, `input_object`, `scalar`, `directive`.           | The defaults are found in _lib/graphql-docs/landing_pages/_.                                                                                          |
+| `classes`            | Additional class names you can provide to certain elements.                                                                                                                                                                    | The full list is available in _lib/graphql-docs/configuration.rb_.                                                                                    |
+| `notices`            | A proc used to add notices to schema members. See _Customizing Notices_ section below.                                                                                                                                         | `nil`                                                                                                                                                 |
 
 ### Customizing Notices
 
@@ -143,11 +157,11 @@ The proc will be called for each schema member and needs to return an array of n
 
 A `notice` has the following options:
 
-| Option | Description |
-| :----- | :---------- |
-| `body` | CommonMark body of the notice |
-| `title` | Optional title of the notice |
-| `class` | Optional CSS class for the wrapper `<div>` of the notice |
+| Option        | Description                                               |
+| :------------ | :-------------------------------------------------------- |
+| `body`        | CommonMark body of the notice                             |
+| `title`       | Optional title of the notice                              |
+| `class`       | Optional CSS class for the wrapper `<div>` of the notice  |
 | `title_class` | Optional CSS class for the `<span>` of the notice's title |
 
 Example of a `notices` proc that adds a notice to the `TeamDiscussion` type:
@@ -181,19 +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 officially supports **Ruby 3.1 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
 

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,57 @@
+#!/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("-v", "--version", "Show the version")
+  parser.on("--verbose", "Run in verbose mode")
+end.parse!(into: opts)
+
+if opts[:version]
+  puts("v#{GraphQLDocs::VERSION}")
+  exit
+end
+
+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

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Easily generate beautiful documentation from your GraphQL schema.'
   spec.description   = <<-EOF
-    GraphQLDocs is a library for generating HTML from a GraphQL API's schema
+    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
@@ -29,29 +29,28 @@ Gem::Specification.new do |spec|
   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 = '>= 3.1'
+
   spec.add_dependency 'graphql', '~> 2.0'
 
   # rendering
-  spec.add_dependency 'commonmarker', '~> 0.16'
-  spec.add_dependency 'escape_utils', '~> 1.2.2'
+  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 'sass-embedded', '~> 1.58'
 
-  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,9 @@
 # frozen_string_literal: true
 
 require 'erb'
-require 'sass'
+require 'fileutils'
+require 'sass-embedded'
+require 'ostruct'
 
 module GraphQLDocs
   class Generator
@@ -84,8 +86,8 @@ module GraphQLDocs
         assets_dir = File.join(File.dirname(__FILE__), 'layouts', 'assets')
         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`
+        css = Sass.compile(File.join(assets_dir, 'css', 'screen.scss')).css
+        File.write(File.join(@options[:output_dir], 'assets', 'style.css'), 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/helpers.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'commonmarker'
+require 'ostruct'
 
 module GraphQLDocs
   module Helpers

data/lib/graphql-docs/landing_pages/enum.md

@@ -6,4 +6,4 @@ title: Enums
 
 Enums represent a possible set of values for a field. For example, the `Issue` object has a field called `state`. The state of an issue may be `OPEN` or `CLOSED`.
 
-For more information, see [the GraphQL spec](https://facebook.github.io/graphql/#sec-Enums).
+For more information, see [the GraphQL spec](http://spec.graphql.org/draft/#sec-Enums).

data/lib/graphql-docs/landing_pages/input_object.md

@@ -6,4 +6,4 @@ title: Input Objects
 
 Input objects are best described as "composable objects" in that they contain a set of input fields that define a particular object. For example, the `AuthorInput` takes a field called `emails`. Providing a value for `emails` will transform the `AuthorInput` into a list of `User` objects which contain that email address/
 
-For more information, see [the GraphQL spec](https://facebook.github.io/graphql/#sec-Input-Objects).
+For more information, see [the GraphQL spec](http://spec.graphql.org/draft/#sec-Input-Objects).

data/lib/graphql-docs/landing_pages/interface.md

@@ -6,4 +6,4 @@ title: Interfaces
 
 GraphQL Interfaces are a sort of "parent object" from which other objects can "inherit" from. For example, `Stars` is considered an interface, because both `Repository` and `Gist` can be starred. An interface has its own list of named fields that are shared by implementing objects.
 
-For more information, see [the GraphQL spec](https://facebook.github.io/graphql/#sec-Interfaces).
+For more information, see [the GraphQL spec](http://spec.graphql.org/draft/#sec-Interfaces).

data/lib/graphql-docs/landing_pages/mutation.md

@@ -8,4 +8,4 @@ Every GraphQL schema has a root type for both queries and mutations.
 
 The mutation type defines how GraphQL operations change data. It is analogous to performing HTTP verbs such as `POST`, `PATCH`, and `DELETE`.
 
-For more information, see [the GraphQL spec](https://facebook.github.io/graphql/#sec-Type-System).
+For more information, see [the GraphQL spec](http://spec.graphql.org/draft/#sec-Type-System).

data/lib/graphql-docs/landing_pages/object.md

@@ -5,4 +5,4 @@ title: Objects
 
 Objects in GraphQL represent the resources that you can access. Objects can contain a list of fields, which are specifically typed. For example, the `Repository` object has a field called `name`, which is a `String`.
 
-For more information, see [the GraphQL spec](https://facebook.github.io/graphql/#sec-Objects).
+For more information, see [the GraphQL spec](http://spec.graphql.org/draft/#sec-Objects).

data/lib/graphql-docs/landing_pages/query.md

@@ -1,4 +1,4 @@
 ---
 title: Queries
 ---
-Every GraphQL schema has a root type for both queries and mutations. The [query type](https://facebook.github.io/graphql/#sec-Type-System) defines GraphQL operations that retrieve data from the server.
+Every GraphQL schema has a root type for both queries and mutations. The [query type](http://spec.graphql.org/draft/#sec-Type-System) defines GraphQL operations that retrieve data from the server.

data/lib/graphql-docs/landing_pages/scalar.md

@@ -6,4 +6,4 @@ title: Scalars
 
 Scalars are primitive values such as `Int` or `String`.
 
-For more information, see [the GraphQL spec](https://facebook.github.io/graphql/#sec-Scalars).
+For more information, see [the GraphQL spec](http://spec.graphql.org/draft/#sec-Scalars).

data/lib/graphql-docs/landing_pages/union.md

@@ -6,4 +6,4 @@ title: Unions
 
 A union is a type of object that can represent one of many kinds of objects. For example, a field marked as a `ReactableUnion` could be a `CommitComment`, an `Issue`, an `IssueComment`, or a `PullRequestReviewComment`, because each of those objects can be reacted on.
 
-For more information, see [the GraphQL spec](https://facebook.github.io/graphql/#sec-Unions).
+For more information, see [the GraphQL spec](http://spec.graphql.org/draft/#sec-Unions).

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

@@ -177,6 +177,10 @@ module GraphQLDocs
             h[:description] = arg.description
             h[:type] = generate_type(arg.type)
             h[:default_value] = arg.default_value if arg.default_value?
+            if arg.respond_to?(:deprecation_reason) && arg.deprecation_reason
+              h[:is_deprecated] = true
+              h[:deprecation_reason] = arg.deprecation_reason
+            end
             hash[:arguments] << h
           end
         end

data/lib/graphql-docs/renderer.rb

@@ -3,6 +3,7 @@
 require 'html/pipeline'
 require 'yaml'
 require 'extended-markdown-filter'
+require 'ostruct'
 
 module GraphQLDocs
   class Renderer

data/lib/graphql-docs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphQLDocs
-  VERSION = '3.0.1'
+  VERSION = '5.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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Brett Chalupa
 - Garen Torikian
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -29,30 +29,36 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: extended-markdown-filter
   requirement: !ruby/object:Gem::Requirement
@@ -85,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: sass-embedded
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.58'
   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.58'
 - !ruby/object:Gem::Dependency
   name: html-proofer
   requirement: !ruby/object:Gem::Requirement
@@ -166,75 +164,47 @@ 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'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-standard
-  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: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -264,25 +234,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 description: |2
-      GraphQLDocs is a library for generating HTML from a GraphQL API's schema
+      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:
 - brettchalupa@gmail.com
-executables: []
+executables:
+- graphql-docs
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.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
@@ -354,8 +333,6 @@ files:
 - lib/graphql-docs/parser.rb
 - lib/graphql-docs/renderer.rb
 - lib/graphql-docs/version.rb
-- script/bootstrap
-- script/console
 homepage: https://github.com/brettchalupa/graphql-docs
 licenses:
 - MIT
@@ -371,14 +348,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: Easily generate beautiful documentation from your GraphQL schema.

data/script/bootstrap

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