graphql-docs 5.2.0 → 6.0.0

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Brett Chalupa
 - Garen Torikian
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -29,22 +28,16 @@ dependencies:
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.23.6
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '2.0'
   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.23'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: escape_utils
   requirement: !ruby/object:Gem::Requirement
@@ -59,54 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: extended-markdown-filter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: gemoji
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.14.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   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.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sass-embedded
   requirement: !ruby/object:Gem::Requirement
@@ -155,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -192,47 +165,81 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +268,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 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
@@ -274,24 +295,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/workflows/tests.yml"
-- ".gitignore"
-- ".rubocop.yml"
+- ".yardopts"
 - 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/app.rb
 - lib/graphql-docs/configuration.rb
 - lib/graphql-docs/generator.rb
 - lib/graphql-docs/helpers.rb
@@ -317,28 +331,8 @@ files:
 - lib/graphql-docs/layouts/assets/_sass/_syntax.scss
 - lib/graphql-docs/layouts/assets/_sass/_types.scss
 - lib/graphql-docs/layouts/assets/css/screen.scss
-- lib/graphql-docs/layouts/assets/images/graphiql-headers.png
-- lib/graphql-docs/layouts/assets/images/graphiql-variables.png
-- lib/graphql-docs/layouts/assets/images/graphiql.png
 - lib/graphql-docs/layouts/assets/images/menu.png
 - lib/graphql-docs/layouts/assets/images/navbar.png
-- lib/graphql-docs/layouts/assets/images/search.svg
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.eot
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.ttf
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.woff
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_B_0.woff2
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.eot
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.ttf
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.woff
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_C_0.woff2
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.eot
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.ttf
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.woff
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_D_0.woff2
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.eot
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.ttf
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.woff
-- lib/graphql-docs/layouts/assets/webfonts/2C4B9D_E_0.woff2
 - lib/graphql-docs/layouts/default.html
 - lib/graphql-docs/layouts/graphql_directives.html
 - lib/graphql-docs/layouts/graphql_enums.html
@@ -363,14 +357,17 @@ files:
 - lib/graphql-docs/parser.rb
 - lib/graphql-docs/renderer.rb
 - lib/graphql-docs/version.rb
+- lib/tasks/graphql-docs.rake
 homepage: https://github.com/brettchalupa/graphql-docs
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://graphql-docs.bcodes.me
   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:
+  documentation_uri: https://rubydoc.info/github/brettchalupa/graphql-docs.git/main
+  source_code_uri: https://github.com/brettchalupa/graphql-docs
 rdoc_options: []
 require_paths:
 - lib
@@ -385,8 +382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Easily generate beautiful documentation from your GraphQL schema.
 test_files: []

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,31 +0,0 @@
----
-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

@@ -1,20 +0,0 @@
----
-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,21 +0,0 @@
-name: Ruby
-
-on: [push, pull_request]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby-version: [3.4, 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

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/output/
-/test/graphql-docs/fixtures/output/
-/.sass-cache/
-/output/
-.byebug_history
-*.gem

data/.rubocop.yml

@@ -1,11 +0,0 @@
-require: rubocop-performance
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Naming/FileName:
-  Enabled: false
-
-Layout/IndentationWidth:
-  Width: 2

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# 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

@@ -1,18 +0,0 @@
-# Contributing 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/Gemfile

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

data/Rakefile

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new(:rubocop)
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.warning = false
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task default: :test
-
-desc 'Invoke HTML-Proofer'
-task :html_proofer do
-  Rake::Task[:generate_sample].invoke('https://www.gjtorikian.com/graphql-docs')
-  require 'html-proofer'
-  output_dir = File.join(File.dirname(__FILE__), 'output')
-
-  proofer_options = { disable_external: true, assume_extension: true }
-  HTMLProofer.check_directory(output_dir, proofer_options).run
-end
-
-desc 'Set up a console'
-task :console do
-  require 'graphql-docs'
-
-  def reload!
-    files = $LOADED_FEATURES.select { |feat| feat =~ %r{/graphql-docs/} }
-    files.each { |file| load file }
-  end
-
-  require 'irb'
-  ARGV.clear
-  IRB.start
-end
-
-namespace :sample do
-  desc 'Generate the sample documentation'
-  task :generate do
-    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')
-
-    puts "Generating sample docs"
-    GraphQLDocs.build(options)
-  end
-
-  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'
-task :publish do
-  ENV['GQL_DOCS_BASE_URL'] = '/graphql-docs'
-  Rake::Task[:generate_sample].invoke('https://www.gjtorikian.com/graphql-docs')
-  Dir.mktmpdir do |tmp|
-    system "mv output/* #{tmp}"
-    system 'git checkout gh-pages'
-    system 'rm -rf *'
-    system "mv #{tmp}/* ."
-    message = "Site updated at #{Time.now.utc}"
-    system 'git add .'
-    system "git commit -am #{message.shellescape}"
-    system 'git push origin gh-pages --force'
-    system 'git checkout master'
-    system 'echo yolo'
-  end
-end

data/lib/graphql-docs/layouts/assets/images/search.svg

@@ -1,3 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
-  <path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14" />
-</svg>