graphql-docs 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f020e4e5b4934ba5304c8b806fe7467580a69d6cf1c46bcfdb9da87616e5d7a2
-  data.tar.gz: 46221390779db63e655ee6056cb73e82d428d3e1447e49668023bf0adc0f3a50
+  metadata.gz: 99086c3e1811e349aa9ea5cec00715e8d4809ed3645a7b4ca6867a945958ad9b
+  data.tar.gz: e46166af01f325dd73dd6f328c070c8d23437fc6e4e8734b22d4607462b9eea6
 SHA512:
-  metadata.gz: 1ea882325c99359946bc746a83e4b83c91bebd904b9021fb0ec28122a3f8a2d5ffeec287b15aefa5c83616442b6c5aa1b0d2ba7a426422270871d92cfcae5933
-  data.tar.gz: 57ad8d227e62610adb18e519e19dcdfef9254270244fe422afc0ff66357e5c3a03e1d5195d56a5d53e3f495da913a7b1bd63afeaada3b3c2a843229b2b0395bf
+  metadata.gz: c464e56c73fc3ffdd31a89a1793e3c3fdb3014766f05d6ea4d95bcf158302a0a506b2278fd36f4994660b92f38dd8769cc1901c343ddda5bddb41714a593ad56
+  data.tar.gz: 3ca5e79abb61fa954695ea37c4368bbcfcf43ca5a3269bd800ea3595abcbde686a4006978393d192a9d862a9dfd72a25e320a818433c77fdfcbb04483d0d21ac

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, 2.5.9]
+
+    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/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 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.
+
+## v3.0.1
+
+- 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
+
+- Upgrades `graphql` gem to the 2.x series

data/LICENSE.txt

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

data/README.md

@@ -194,3 +194,7 @@ bundle exec rake sample
 ```
 
 to see some sample output.
+
+## Credits
+
+Originally built by [gjtorikian](https://github.com/gjtorikian). Actively maintained by [brettchalupa](https://github.com/brettchalupa).

data/graphql-docs.gemspec

@@ -7,12 +7,24 @@ 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
+    GraphQLDocs is a library for generating HTML 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)/})
@@ -21,11 +33,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'graphql', '~> 1.12'
+  spec.add_dependency 'graphql', '~> 2.0'
 
   # rendering
   spec.add_dependency 'commonmarker', '~> 0.16'
-  spec.add_dependency 'escape_utils', '~> 1.2'
+  spec.add_dependency 'escape_utils', '~> 1.2.2'
   spec.add_dependency 'extended-markdown-filter', '~> 0.4'
   spec.add_dependency 'gemoji', '~> 3.0'
   spec.add_dependency 'html-pipeline', '~> 2.9'
@@ -41,4 +53,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-standard'
   spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'webrick', '~> 1.7'
 end

data/lib/graphql-docs/version.rb

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

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: graphql-docs
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.1
 platform: ruby
 authors:
+- Brett Chalupa
 - Garen Torikian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: extended-markdown-filter
   requirement: !ruby/object:Gem::Requirement
@@ -248,17 +249,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: |2
+      GraphQLDocs is a library for generating HTML 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
+- brettchalupa@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -336,10 +356,13 @@ files:
 - 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:
@@ -355,7 +378,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+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