graphql-docs 1.3.5 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: bd333b3b4214ce691d4f8f64645c706280a068ff
4
- data.tar.gz: 1dc7d2814ce8ecd1d5751a8acda770ecfc8cddf7
3
+ metadata.gz: 72ec410a12852586cbdf082b669fc6dc04a04883
4
+ data.tar.gz: 604571380c7008a7b1e708a3b9063718d94123c6
5
5
  SHA512:
6
- metadata.gz: 6704934871fee571da7c31c4f00e18f8ff06d27ba3ef8e079825e3939eff1176df70c63f0d1287de89ebfd2b28401305b3efe8c6e4eb45ffaacc74b00571b030
7
- data.tar.gz: b710e45e461dc202921b7ee78ccbdaf2022f282bb92d26fc144edf666a6c41c11d15518051671addaadf2de98cb40c3f89d2018c23617ae71bba25a972afebe2
6
+ metadata.gz: cafa5a5fd565c857dcb7564f32b3e669d9ead0c0f2ed9b9a294139ee01eb5d9dce34c79387e3d71b6be548f51e46c983cc3e10689e187a507284d5efc74ec5ee
7
+ data.tar.gz: 679c13720eb0c6cc2aa9bdb6fed436beb9779d5d78336ac419471d9e11c6ef5b789effe8a79b8301ce2037ddb15be0de6615fde3ccb30a80befce09bbf6b5eff
data/.gitignore CHANGED
@@ -11,3 +11,4 @@
11
11
  /test/graphql-docs/fixtures/output/
12
12
  /.sass-cache/
13
13
  /output/
14
+ .byebug_history
data/README.md CHANGED
@@ -28,6 +28,12 @@ GraphQLDocs.build(filename: filename)
28
28
 
29
29
  # or pass in a string
30
30
  GraphQLDocs.build(schema: contents)
31
+
32
+ # or a schema class
33
+ schema = GraphQL::Schema.define do
34
+ query query_type
35
+ end
36
+ GraphQLDocs.build(schema: schema)
31
37
  ```
32
38
 
33
39
  ## Breakdown
data/Rakefile CHANGED
@@ -17,12 +17,15 @@ task default: :test
17
17
  Rake::Task[:test].enhance { Rake::Task[:html_proofer].invoke }
18
18
 
19
19
  desc 'Invoke HTML-Proofer'
20
- task html_proofer: [:generate_sample] do
21
- require 'html-proofer'
22
- output_dir = File.join(File.dirname(__FILE__), 'output')
23
-
24
- proofer_options = { disable_external: true, assume_extension: true }
25
- HTMLProofer.check_directory(output_dir, proofer_options).run
20
+ task :html_proofer do
21
+ if ENV['CI']
22
+ Rake::Task[:generate_sample].invoke('https://www.gjtorikian.com/graphql-docs')
23
+ require 'html-proofer'
24
+ output_dir = File.join(File.dirname(__FILE__), 'output')
25
+
26
+ proofer_options = { disable_external: true, assume_extension: true }
27
+ HTMLProofer.check_directory(output_dir, proofer_options).run
28
+ end
26
29
  end
27
30
 
28
31
  desc 'Set up a console'
data/graphql-docs.gemspec CHANGED
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
33
33
  spec.add_development_dependency 'html-proofer', '~> 3.4'
34
34
  spec.add_development_dependency 'minitest', '~> 5.0'
35
35
  spec.add_development_dependency 'minitest-focus', '~> 1.1'
36
- spec.add_development_dependency 'pry', '~> 0.10.0'
36
+ spec.add_development_dependency 'pry-byebug', '~> 3.6'
37
37
  spec.add_development_dependency 'rake'
38
38
  spec.add_development_dependency 'rubocop-github'
39
39
  spec.add_development_dependency 'webmock', '~> 2.3'
data/lib/graphql-docs.rb CHANGED
@@ -1,4 +1,4 @@
1
- # rubocop:disable Style/FileName
1
+ # rubocop:disable Naming/FileName
2
2
  require 'graphql-docs/helpers'
3
3
  require 'graphql-docs/renderer'
4
4
  require 'graphql-docs/configuration'
@@ -38,8 +38,8 @@ module GraphQLDocs
38
38
 
39
39
  schema = File.read(filename)
40
40
  else
41
- unless schema.is_a?(String)
42
- raise TypeError, "Expected `String`, got `#{schema.class}`"
41
+ if !schema.is_a?(String) && !schema.is_a?(GraphQL::Schema)
42
+ raise TypeError, "Expected `String` or `GraphQL::Schema`, got `#{schema.class}`"
43
43
  end
44
44
 
45
45
  schema = schema
@@ -11,7 +11,12 @@ module GraphQLDocs
11
11
 
12
12
  @options[:notices] ||= -> (schema_member_path) { [] }
13
13
 
14
- @schema = GraphQL::Schema.from_definition(schema)
14
+ if schema.is_a?(GraphQL::Schema)
15
+ @schema = schema
16
+ else
17
+ @schema = GraphQL::Schema.from_definition(schema)
18
+ end
19
+
15
20
  @processed_schema = {
16
21
  operation_types: [],
17
22
  mutation_types: [],
@@ -1,3 +1,3 @@
1
1
  module GraphQLDocs
2
- VERSION = '1.3.5'
2
+ VERSION = '1.4.0'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: graphql-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.5
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Garen Torikian
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-03-25 00:00:00.000000000 Z
11
+ date: 2018-05-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: graphql
@@ -151,19 +151,19 @@ dependencies:
151
151
  - !ruby/object:Gem::Version
152
152
  version: '1.1'
153
153
  - !ruby/object:Gem::Dependency
154
- name: pry
154
+ name: pry-byebug
155
155
  requirement: !ruby/object:Gem::Requirement
156
156
  requirements:
157
157
  - - "~>"
158
158
  - !ruby/object:Gem::Version
159
- version: 0.10.0
159
+ version: '3.6'
160
160
  type: :development
161
161
  prerelease: false
162
162
  version_requirements: !ruby/object:Gem::Requirement
163
163
  requirements:
164
164
  - - "~>"
165
165
  - !ruby/object:Gem::Version
166
- version: 0.10.0
166
+ version: '3.6'
167
167
  - !ruby/object:Gem::Dependency
168
168
  name: rake
169
169
  requirement: !ruby/object:Gem::Requirement