graphql-schema_comparator 0.6.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3b2c5111538092113b88552e2d85930eea51b4c0
-  data.tar.gz: 3a3b4d43916961515caa915c51e0c0b0370c1395
+SHA256:
+  metadata.gz: fbc98aaf530ce8c60dc291eac091f735180bedd7962f4229d6fc9ad19fcf02a9
+  data.tar.gz: e80de95b6b466297e8c69679cd2f4590f7bc77072573df004b0c8e266e06a9ef
 SHA512:
-  metadata.gz: 00c6e2702e8bb9c1f34b1d9a777a3b63cc0cb6f56aa78f76bf14c04aee0997e6e690f79de956d46da31be9298a98ff72413d5cd77f18b514cd0b6b8a02021f76
-  data.tar.gz: b74179eb8941cf2985f9dda75219b28b001e4c771db5db3d49e380cc98bc94c625d720dd7bf4cb88ddef6e51672b0a50b136b92da3e6dbfc6af3c13874e8c65f
+  metadata.gz: 22b0ef77facfe02f84f0d14004c4576d415d9b3c4b3fe46d06ed0a3750ea302180217c1aec1b54cdefd0517f66a0f89a61789643ad66031766205cc03e95459f
+  data.tar.gz: 4e2251295877a04cfa6e15654470db736a52bda927be70dc0d3846e358d6d6d7d11553a04bfff383eb460d62b466bcb7610d3bb84d16fb613418af8d7884df4c

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: Tests
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.7, '3.0']
+        gemfile: [graphql1.10, graphql1.13, graphql-head]
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 1.1.0 (December 20 2021)
+
+### Bug Fix
+
+  - Adding non-null arguments with a default value should be non-breaking (#38)
+
+### New Features
+
+  - Remove legacy `graphql` gem API usage and support versions >= 1.13 (#46)
+
+## 1.0.1 (May 26 2021)
+
+### Bug Fix
+
+  - Fix comparing directives (#36)
+
+## 1.0.0 (January 23 2020)
+
+### Breaking Changes
+
+  - Add support for graphql-ruby 1.10.0+ (#28)
+  - Starting from 1.0.0 a minimum of graphql-ruby 1.10 is required
+
+## 0.6.1 (May 21rst 2019)
+
+  - Added a bunch of reasons to breaking changes (#17)
+  - Relaxed Thor Dependency
+  - Add `verify` task for CI usage which returns exit codes depending on breaking changes (#24)
+
 ## 0.6.0 (Feb 28th 2018)
 
 ### New Features
@@ -48,32 +77,32 @@ Added changes:
 
 ### Bug fixes
 
-Fix issue in Enum differ (https://github.com/xuorig/graphql-schema_comparator/issues/9)
+  - Fix issue in Enum differ (https://github.com/xuorig/graphql-schema_comparator/issues/9)
 
 ## 0.3.1 (Nov 13 2017)
 
 ### Bug Fixes
 
-- Fix no method breaking issue https://github.com/xuorig/graphql-schema_comparator/issues/8
+  - Fix no method breaking issue https://github.com/xuorig/graphql-schema_comparator/issues/8
 
 ## 0.3.0 (Oct 14 2017)
 
 ### New features
 
-- Top level Directive definitions are now diffed, but not directives used on definitions (Coming soon)
-- Base class for changes added.
+  - Top level Directive definitions are now diffed, but not directives used on definitions (Coming soon)
+  - Base class for changes added.
 
 ### breaking changes
 
-- `breaking` method on change objects has been renamed `breaking?` for style
+  - `breaking` method on change objects has been renamed `breaking?` for style
 
 ## 0.2.0 (Aug 18 2017)
 
 ### New features
 
-- Add `#non_breaking_changes` to get a list of non breaking changes from a comparison result. (#4)
-- CLI now Prints results sorted and grouped by breaking / non-breaking (#3)
+  - Add `#non_breaking_changes` to get a list of non breaking changes from a comparison result. (#4)
+  - CLI now Prints results sorted and grouped by breaking / non-breaking (#3)
 
 ### Bug fixes
 
-- Fix message for `EnumValueRemoved` (#5)
+  - Fix message for `EnumValueRemoved` (#5)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 TODO: Write your name
+Copyright (c) 2017 Marc-Andre Giroux
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # GraphQL::SchemaComparator
 
-[![Build Status](https://travis-ci.org/xuorig/graphql-schema_comparator.svg?branch=master)](https://travis-ci.org/xuorig/graphql-schema_comparator)
+![Build status](https://github.com/xuorig/graphql-schema_comparator/actions/workflows/ci.yml/badge.svg)
 
 `GraphQL::SchemaComparator` is a GraphQL Schema comparator. What does that mean? `GraphQL::SchemaComparator` takes
 two GraphQL schemas and outputs a list of changes between versions. This is useful for many things:
@@ -87,7 +87,7 @@ Possible changes are all found in [changes.rb](lib/graphql/schema_comparator/cha
 
 ### Change Criticality
 
-Each change object has a ``#criticality` method which returns a `Changes::Criticality` object.
+Each change object has a `#criticality` method which returns a `Changes::Criticality` object.
 This objects defines how dangerous a change is to a schema.
 
 The different levels of criticality (non_breaking, dangerous, breaking) are explained here:

data/bin/schema_comparator

@@ -5,9 +5,23 @@ require "thor"
 require "graphql/schema_comparator"
 
 class GraphQLSchema < Thor
+  desc "verify OLD_SCHEMA NEW_SCHEMA", "Behaves exactly like `compare` but returns an exit code for CI purposes"
+
+  def verify(old_schema, new_schema)
+    result = run_compare(old_schema, new_schema)
+    exit_code = result.breaking? ? 1 : 0
+    exit(exit_code)
+  end
+
   desc "compare OLD_SCHEMA NEW_SCHEMA", "Compares OLD_SCHEMA with NEW_SCHEMA and returns a list of changes"
 
   def compare(old_schema, new_schema)
+    run_compare(old_schema, new_schema)
+  end
+
+  private
+
+  def run_compare(old_schema, new_schema)
     parsed_old = parse_schema(old_schema)
     parsed_new = parse_schema(new_schema)
 
@@ -22,10 +36,9 @@ class GraphQLSchema < Thor
     else
       print_changes(result)
     end
+    result
   end
 
-  private
-
   def print_changes(result)
     say "Detected the following changes between schemas:"
     say "\n"

data/gemfiles/graphql-head.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "graphql", "~> 1.13", "< 3.0"
+
+gemspec path: "../"

data/gemfiles/graphql1.10.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "graphql", "~> 1.10.0"
+
+gemspec path: "../"

data/gemfiles/graphql1.13.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "graphql", "~> 1.13.0"
+
+gemspec path: "../"

data/graphql-schema_comparator.gemspec

@@ -8,23 +8,28 @@ Gem::Specification.new do |spec|
   spec.version       = GraphQL::SchemaComparator::VERSION
   spec.authors       = ["Marc-Andre Giroux"]
   spec.email         = ["mgiroux0@gmail.com"]
-
   spec.summary       = %q{Compare GraphQL schemas and get the changes that happened.}
-  spec.description   = %q{GraphQL::SchemaComparator compares two GraphQL schemas given their IDL and returns a list of changes.}
-  spec.homepage      = "http://mgiroux.me"
+  spec.description   = %q{GraphQL::SchemaComparator compares two GraphQL schemas given their SDL and returns a list of changes.}
+  spec.homepage      = "https://github.com/xuorig/graphql-schema_comparator"
   spec.license       = "MIT"
-
+  spec.metadata         = {
+    "homepage_uri"    => "https://github.com/xuorig/graphql-schema_comparator",
+    "changelog_uri"   => "https://github.com/xuorig/graphql-schema_comparator/blob/master/CHANGELOG.md",
+    "source_code_uri" => "https://github.com/xuorig/graphql-schema_comparator",
+    "bug_tracker_uri" => "https://github.com/xuorig/graphql-schema_comparator/issues",
+  }
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
+
   spec.bindir        = "bin"
   spec.executables   = ["graphql-schema", "schema_comparator"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "graphql", "~> 1.6"
-  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "graphql", ">= 1.10", "< 3.0"
+  spec.add_dependency "thor", ">= 0.19", "< 2.0"
+  spec.add_dependency "bundler", ">= 1.14"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.10"
   spec.add_development_dependency "pry-byebug", "~> 3.4"

data/lib/graphql/schema_comparator/changes/criticality.rb

@@ -14,7 +14,7 @@ module GraphQL
         # these changes.
         DANGEROUS = 2
 
-        # Breaking criticality are changes that immediatly impact
+        # Breaking criticality are changes that immediately impact
         # clients usually causing queries not to be valid anymore.
         BREAKING = 3
 

data/lib/graphql/schema_comparator/changes.rb

@@ -45,15 +45,17 @@ module GraphQL
 
         def initialize(removed_type)
           @removed_type = removed_type
-          @criticality = Changes::Criticality.breaking
+          @criticality = Changes::Criticality.breaking(
+            reason: "Removing a type is a breaking change. It is preferable to deprecate and remove all references to this type first."
+          )
         end
 
         def message
-          "Type `#{removed_type.name}` was removed"
+          "Type `#{removed_type.graphql_name}` was removed"
         end
 
         def path
-          removed_type.name
+          removed_type.path
         end
       end
 
@@ -66,11 +68,11 @@ module GraphQL
         end
 
         def message
-          "Directive `#{directive.name}` was removed"
+          "Directive `#{directive.graphql_name}` was removed"
         end
 
         def path
-          "@#{directive.name}"
+          "@#{directive.graphql_name}"
         end
       end
 
@@ -80,15 +82,17 @@ module GraphQL
         def initialize(old_type, new_type)
           @old_type = old_type
           @new_type = new_type
-          @criticality = Changes::Criticality.breaking
+          @criticality = Changes::Criticality.breaking(
+            reason: "Changing the kind of a type is a breaking change because it can cause existing queries to error. For example, turning an object type to a scalar type would break queries that define a selection set for this type."
+          )
         end
 
         def message
-          "`#{old_type.name}` kind changed from `#{old_type.kind}` to `#{new_type.kind}`"
+          "`#{old_type.graphql_name}` kind changed from `#{old_type.kind}` to `#{new_type.kind}`"
         end
 
         def path
-          old_type.name
+          old_type.path
         end
       end
 
@@ -98,15 +102,17 @@ module GraphQL
         def initialize(enum_type, enum_value)
           @enum_value = enum_value
           @enum_type = enum_type
-          @criticality = Changes::Criticality.breaking
+          @criticality = Changes::Criticality.breaking(
+            reason: "Removing an enum value will cause existing queries that use this enum value to error."
+          )
         end
 
         def message
-          "Enum value `#{enum_value.name}` was removed from enum `#{enum_type.name}`"
+          "Enum value `#{enum_value.graphql_name}` was removed from enum `#{enum_type.graphql_name}`"
         end
 
         def path
-          [enum_type.name, enum_value.name].join('.')
+          enum_value.path
         end
       end
 
@@ -116,15 +122,17 @@ module GraphQL
         def initialize(union_type, union_member)
           @union_member = union_member
           @union_type = union_type
-          @criticality = Changes::Criticality.breaking
+          @criticality = Changes::Criticality.breaking(
+            reason: "Removing a union member from a union can cause existing queries that use this union member in a fragment spread to error."
+          )
         end
 
         def message
-          "Union member `#{union_member.name}` was removed from Union type `#{union_type.name}`"
+          "Union member `#{union_member.graphql_name}` was removed from Union type `#{union_type.graphql_name}`"
         end
 
         def path
-          union_type.name
+          union_type.path
         end
       end
 
@@ -134,15 +142,17 @@ module GraphQL
         def initialize(input_object_type, field)
           @input_object_type = input_object_type
           @field = field
-          @criticality = Changes::Criticality.breaking
+          @criticality = Changes::Criticality.breaking(
+            reason: "Removing an input field will cause existing queries that use this input field to error."
+          )
         end
 
         def message
-          "Input field `#{field.name}` was removed from input object type `#{input_object_type.name}`"
+          "Input field `#{field.graphql_name}` was removed from input object type `#{input_object_type.graphql_name}`"
         end
 
         def path
-          [input_object_type.name, field.name].join('.')
+          field.path
         end
       end
 
@@ -153,15 +163,17 @@ module GraphQL
           @object_type = object_type
           @field = field
           @argument = argument
-          @criticality = Changes::Criticality.breaking
+          @criticality = Changes::Criticality.breaking(
+            reason: "Removing a field argument is a breaking change because it will cause existing queries that use this argument to error."
+          )
         end
 
         def message
-          "Argument `#{argument.name}: #{argument.type}` was removed from field `#{object_type.name}.#{field.name}`"
+          "Argument `#{argument.graphql_name}: #{argument.type.graphql_name}` was removed from field `#{object_type.graphql_name}.#{field.graphql_name}`"
         end
 
         def path
-          [object_type.name, field.name, argument.name].join('.')
+          argument.path
         end
       end
 
@@ -175,11 +187,11 @@ module GraphQL
         end
 
         def message
-          "Argument `#{argument.name}` was removed from directive `#{directive.name}`"
+          "Argument `#{argument.graphql_name}` was removed from directive `#{directive.graphql_name}`"
         end
 
         def path
-          ["@#{directive.name}", argument.name].join('.')
+          ["@#{directive.graphql_name}", argument.graphql_name].join('.')
         end
       end
 
@@ -193,7 +205,7 @@ module GraphQL
         end
 
         def message
-          "Schema query root has changed from `#{old_schema.query.name}` to `#{new_schema.query.name}`"
+          "Schema query root has changed from `#{old_schema.query.graphql_name}` to `#{new_schema.query.graphql_name}`"
         end
 
         def path
@@ -207,15 +219,25 @@ module GraphQL
         def initialize(object_type, field)
           @object_type = object_type
           @field = field
-          @criticality = Changes::Criticality.breaking
+
+          if field.deprecation_reason
+            @criticality = Changes::Criticality.breaking(
+              reason: "Removing a deprecated field is a breaking change. Before removing it, you may want" \
+                "to look at the field's usage to see the impact of removing the field."
+            )
+          else
+            @criticality = Changes::Criticality.breaking(
+              reason: "Removing a field is a breaking change. It is preferable to deprecate the field before removing it."
+            )
+          end
         end
 
         def message
-          "Field `#{field.name}` was removed from object type `#{object_type.name}`"
+          "Field `#{field.graphql_name}` was removed from object type `#{object_type.graphql_name}`"
         end
 
         def path
-          [object_type.name, field.name].join('.')
+          [object_type.graphql_name, field.graphql_name].join(".")
         end
       end
 
@@ -229,11 +251,11 @@ module GraphQL
         end
 
         def message
-          "Location `#{location}` was removed from directive `#{directive.name}`"
+          "Location `#{location}` was removed from directive `#{directive.graphql_name}`"
         end
 
         def path
-          "@#{directive.name}"
+          "@#{directive.graphql_name}"
         end
       end
 
@@ -243,15 +265,17 @@ module GraphQL
         def initialize(interface, object_type)
           @interface = interface
           @object_type = object_type
-          @criticality = Changes::Criticality.breaking
+          @criticality = Changes::Criticality.breaking(
+            reason: "Removing an interface from an object type can cause existing queries that use this in a fragment spread to error."
+          )
         end
 
         def message
-          "`#{object_type.name}` object type no longer implements `#{interface.name}` interface"
+          "`#{object_type.graphql_name}` object type no longer implements `#{interface.graphql_name}` interface"
         end
 
         def path
-          object_type.name
+          object_type.path
         end
       end
 
@@ -267,19 +291,19 @@ module GraphQL
         end
 
         def message
-          "Field `#{type}.#{old_field.name}` changed type from `#{old_field.type}` to `#{new_field.type}`"
+          "Field `#{old_field.path}` changed type from `#{old_field.type.to_type_signature}` to `#{new_field.type.to_type_signature}`"
         end
 
         def criticality
           if safe_change_for_field?(old_field.type, new_field.type)
             Changes::Criticality.non_breaking
           else
-            Changes::Criticality.breaking
+            Changes::Criticality.breaking # TODO - Add reason
           end
         end
 
         def path
-          [type.name, old_field.name].join('.')
+          old_field.path
         end
       end
 
@@ -294,7 +318,9 @@ module GraphQL
               reason: "Changing an input field from non-null to null is considered non-breaking"
             )
           else
-            @criticality = Changes::Criticality.breaking
+            @criticality = Changes::Criticality.breaking(
+              reason: "Changing the type of an input field can cause existing queries that use this field to error."
+            )
           end
 
           @input_type = input_type
@@ -303,11 +329,11 @@ module GraphQL
         end
 
         def message
-          "Input field `#{input_type}.#{old_input_field.name}` changed type from `#{old_input_field.type}` to `#{new_input_field.type}`"
+          "Input field `#{path}` changed type from `#{old_input_field.type.to_type_signature}` to `#{new_input_field.type.to_type_signature}`"
         end
 
         def path
-          [input_type.name, old_input_field.name].join('.')
+          old_input_field.path
         end
       end
 
@@ -322,7 +348,9 @@ module GraphQL
               reason: "Changing an input field from non-null to null is considered non-breaking"
             )
           else
-            @criticality = Changes::Criticality.breaking
+            @criticality = Changes::Criticality.breaking(
+              reason: "Changing the type of a field's argument can cause existing queries that use this argument to error."
+            )
           end
 
           @type = type
@@ -332,12 +360,12 @@ module GraphQL
         end
 
         def message
-          "Type for argument `#{new_argument.name}` on field `#{type.name}.#{field.name}` changed"\
-            " from `#{old_argument.type}` to `#{new_argument.type}`"
+          "Type for argument `#{new_argument.graphql_name}` on field `#{field.path}` changed"\
+            " from `#{old_argument.type.to_type_signature}` to `#{new_argument.type.to_type_signature}`"
         end
 
         def path
-          [type.name, field.name, old_argument.name].join('.')
+          old_argument.path
         end
       end
 
@@ -361,12 +389,12 @@ module GraphQL
         end
 
         def message
-          "Type for argument `#{new_argument.name}` on directive `#{directive.name}` changed"\
-            " from `#{old_argument.type}` to `#{new_argument.type}`"
+          "Type for argument `#{new_argument.graphql_name}` on directive `#{directive.graphql_name}` changed"\
+            " from `#{old_argument.type.to_type_signature}` to `#{new_argument.type.to_type_signature}`"
         end
 
         def path
-          ["@#{directive.name}", old_argument.name].join('.')
+          ["@#{directive.graphql_name}", old_argument.graphql_name].join('.')
         end
       end
 
@@ -423,16 +451,16 @@ module GraphQL
         end
 
         def message
-          if old_argument.default_value.nil?
-            "Default value `#{new_argument.default_value}` was added to argument `#{new_argument.name}` on field `#{type.name}.#{field.name}`"
+          if old_argument.default_value.nil? || old_argument.default_value == :__no_default__
+            "Default value `#{new_argument.default_value}` was added to argument `#{new_argument.graphql_name}` on field `#{field.path}`"
           else
-            "Default value for argument `#{new_argument.name}` on field `#{type.name}.#{field.name}` changed"\
+            "Default value for argument `#{new_argument.graphql_name}` on field `#{field.path}` changed"\
               " from `#{old_argument.default_value}` to `#{new_argument.default_value}`"
           end
         end
 
         def path
-          [type.name, field.name, old_argument.name].join('.')
+          old_argument.path
         end
       end
 
@@ -450,12 +478,12 @@ module GraphQL
         end
 
         def message
-          "Input field `#{input_type.name}.#{old_field.name}` default changed"\
+          "Input field `#{path}` default changed"\
             " from `#{old_field.default_value}` to `#{new_field.default_value}`"
         end
 
         def path
-          [input_type.name, old_field.name].join(".")
+          old_field.path
         end
       end
 
@@ -473,12 +501,12 @@ module GraphQL
         end
 
         def message
-          "Default value for argument `#{new_argument.name}` on directive `#{directive.name}` changed"\
+          "Default value for argument `#{new_argument.graphql_name}` on directive `#{directive.graphql_name}` changed"\
             " from `#{old_argument.default_value}` to `#{new_argument.default_value}`"
         end
 
         def path
-          ["@#{directive.name}", new_argument.name].join(".")
+          ["@#{directive.graphql_name}", new_argument.graphql_name].join(".")
         end
       end
 
@@ -495,11 +523,11 @@ module GraphQL
         end
 
         def message
-          "Enum value `#{enum_value.name}` was added to enum `#{enum_type.name}`"
+          "Enum value `#{enum_value.graphql_name}` was added to enum `#{enum_type.graphql_name}`"
         end
 
         def path
-          [enum_type.name, enum_value.name].join(".")
+          enum_value.path
         end
       end
 
@@ -516,11 +544,11 @@ module GraphQL
         end
 
         def message
-          "Union member `#{union_member.name}` was added to Union type `#{union_type.name}`"
+          "Union member `#{union_member.graphql_name}` was added to Union type `#{union_type.graphql_name}`"
         end
 
         def path
-          union_type.name
+          union_type.path
         end
       end
 
@@ -537,11 +565,11 @@ module GraphQL
         end
 
         def message
-          "`#{object_type.name}` object implements `#{interface.name}` interface"
+          "`#{object_type.graphql_name}` object implements `#{interface.graphql_name}` interface"
         end
 
         def path
-          object_type.name
+          object_type.path
         end
       end
 
@@ -551,8 +579,8 @@ module GraphQL
         attr_reader :input_object_type, :field, :criticality
 
         def initialize(input_object_type, field)
-          @criticality = if field.type.non_null?
-            Changes::Criticality.breaking
+          @criticality = if field.type.non_null? && !field.default_value?
+            Changes::Criticality.breaking(reason: "Adding a non-null input field without a default value to an existing input type will cause existing queries that use this input type to error because they will not provide a value for this new field.")
           else
             Changes::Criticality.non_breaking
           end
@@ -562,11 +590,11 @@ module GraphQL
         end
 
         def message
-          "Input field `#{field.name}` was added to input object type `#{input_object_type.name}`"
+          "Input field `#{field.graphql_name}` was added to input object type `#{input_object_type.graphql_name}`"
         end
 
         def path
-          [input_object_type.name, field.name].join(".")
+          field.path
         end
       end
 
@@ -574,8 +602,8 @@ module GraphQL
         attr_reader :type, :field, :argument, :criticality
 
         def initialize(type, field, argument)
-          @criticality = if argument.type.non_null?
-            Changes::Criticality.breaking
+          @criticality = if argument.type.non_null? && !argument.default_value?
+            Changes::Criticality.breaking(reason: "Adding a required argument without a default value to an existing field is a breaking change because it will cause existing uses of this field to error.")
           else
             Changes::Criticality.non_breaking
           end
@@ -586,11 +614,11 @@ module GraphQL
         end
 
         def message
-          "Argument `#{argument.name}: #{argument.type}` added to field `#{type.name}.#{field.name}`"
+          "Argument `#{argument.graphql_name}: #{argument.type.graphql_name}` added to field `#{field.path}`"
         end
 
         def path
-          [type.name, field.name, argument.name].join(".")
+          argument.path
         end
       end
 
@@ -603,11 +631,11 @@ module GraphQL
         end
 
         def message
-          "Type `#{type.name}` was added"
+          "Type `#{type.graphql_name}` was added"
         end
 
         def path
-          type.name
+          type.path
         end
       end
 
@@ -620,11 +648,11 @@ module GraphQL
         end
 
         def message
-          "Directive `#{directive.name}` was added"
+          "Directive `#{directive.graphql_name}` was added"
         end
 
         def path
-          "@#{directive.name}"
+          "@#{directive.graphql_name}"
         end
       end
 
@@ -638,11 +666,11 @@ module GraphQL
         end
 
         def message
-          "Description `#{old_type.description}` on type `#{old_type.name}` has changed to `#{new_type.description}`"
+          "Description `#{old_type.description}` on type `#{old_type.graphql_name}` has changed to `#{new_type.description}`"
         end
 
         def path
-          old_type.name
+          old_type.path
         end
       end
 
@@ -657,12 +685,12 @@ module GraphQL
         end
 
         def message
-          "Description for enum value `#{enum.name}.#{new_enum_value.name}` changed from " \
+          "Description for enum value `#{new_enum_value.path}` changed from " \
             "`#{old_enum_value.description}` to `#{new_enum_value.description}`"
         end
 
         def path
-          [enum.name, old_enum_value.name].join(".")
+          old_enum_value.path
         end
       end
 
@@ -678,16 +706,15 @@ module GraphQL
 
         def message
           if old_enum_value.deprecation_reason
-            "Enum value `#{enum.name}.#{new_enum_value.name}` deprecation reason changed " \
+            "Enum value `#{new_enum_value.path}` deprecation reason changed " \
               "from `#{old_enum_value.deprecation_reason}` to `#{new_enum_value.deprecation_reason}`"
           else
-            "Enum value `#{enum.name}.#{new_enum_value.name}` was deprecated with reason" \
-              " `#{new_enum_value.deprecation_reason}`"
+            "Enum value `#{new_enum_value.path}` was deprecated with reason `#{new_enum_value.deprecation_reason}`"
           end
         end
 
         def path
-          [enum.name, old_enum_value.name].join(".")
+          old_enum_value.path
         end
       end
 
@@ -702,12 +729,12 @@ module GraphQL
         end
 
         def message
-          "Input field `#{input_type.name}.#{old_field.name}` description changed"\
+          "Input field `#{old_field.path}` description changed"\
             " from `#{old_field.description}` to `#{new_field.description}`"
         end
 
         def path
-          [input_type.name, old_field.name].join(".")
+          old_field.path
         end
       end
 
@@ -721,12 +748,12 @@ module GraphQL
         end
 
         def message
-          "Directive `#{new_directive.name}` description changed"\
+          "Directive `#{new_directive.graphql_name}` description changed"\
             " from `#{old_directive.description}` to `#{new_directive.description}`"
         end
 
         def path
-          "@#{old_directive.name}"
+          "@#{old_directive.graphql_name}"
         end
       end
 
@@ -741,12 +768,12 @@ module GraphQL
         end
 
         def message
-          "Field `#{type.name}.#{old_field.name}` description changed"\
+          "Field `#{old_field.path}` description changed"\
             " from `#{old_field.description}` to `#{new_field.description}`"
         end
 
         def path
-          [type.name, old_field.name].join(".")
+          old_field.path
         end
       end
 
@@ -762,12 +789,12 @@ module GraphQL
         end
 
         def message
-          "Description for argument `#{new_argument.name}` on field `#{type.name}.#{field.name}` changed"\
+          "Description for argument `#{new_argument.graphql_name}` on field `#{field.path}` changed"\
             " from `#{old_argument.description}` to `#{new_argument.description}`"
         end
 
         def path
-          [type.name, field.name, old_argument.name].join(".")
+          old_argument.path
         end
       end
 
@@ -782,12 +809,12 @@ module GraphQL
         end
 
         def message
-          "Description for argument `#{new_argument.name}` on directive `#{directive.name}` changed"\
+          "Description for argument `#{new_argument.graphql_name}` on directive `#{directive.graphql_name}` changed"\
             " from `#{old_argument.description}` to `#{new_argument.description}`"
         end
 
         def path
-          ["@#{directive.name}", old_argument.name].join(".")
+          ["@#{directive.graphql_name}", old_argument.graphql_name].join(".")
         end
       end
 
@@ -802,12 +829,12 @@ module GraphQL
         end
 
         def message
-          "Deprecation reason on field `#{type.name}.#{new_field.name}` has changed "\
+          "Deprecation reason on field `#{new_field.path}` has changed "\
             "from `#{old_field.deprecation_reason}` to `#{new_field.deprecation_reason}`"
         end
 
         def path
-          [type.name, old_field.name].join(".")
+          old_field.path
         end
       end
 
@@ -821,11 +848,11 @@ module GraphQL
         end
 
         def message
-          "Field `#{field.name}` was added to object type `#{object_type.name}`"
+          "Field `#{field.graphql_name}` was added to object type `#{object_type.graphql_name}`"
         end
 
         def path
-          [object_type.name, field.name].join(".")
+          [object_type.graphql_name, field.graphql_name].join(".")
         end
       end
 
@@ -839,11 +866,11 @@ module GraphQL
         end
 
         def message
-          "Location `#{location}` was added to directive `#{directive.name}`"
+          "Location `#{location}` was added to directive `#{directive.graphql_name}`"
         end
 
         def path
-          "@#{directive.name}"
+          "@#{directive.graphql_name}"
         end
       end
 
@@ -1005,7 +1032,7 @@ module GraphQL
         end
 
         def message
-          "Argument `#{argument.name}` was added to directive `#{directive.name}`"
+          "Argument `#{argument.graphql_name}` was added to directive `#{directive.graphql_name}`"
         end
       end
     end

data/lib/graphql/schema_comparator/diff/argument.rb

@@ -21,7 +21,7 @@ module GraphQL
             changes << Changes::FieldArgumentDefaultChanged.new(type, field, old_arg, new_arg)
           end
 
-          if old_arg.type != new_arg.type
+          if old_arg.type.to_type_signature != new_arg.type.to_type_signature
             changes << Changes::FieldArgumentTypeChanged.new(type, field, old_arg, new_arg)
           end
 

data/lib/graphql/schema_comparator/diff/directive.rb

@@ -39,11 +39,11 @@ module GraphQL
         end
 
         def removed_arguments
-          old_arguments.values.select { |arg| !new_arguments[arg.name] }
+          old_arguments.values.select { |arg| !new_arguments[arg.graphql_name] }
         end
 
         def added_arguments
-          new_arguments.values.select { |arg| !old_arguments[arg.name] }
+          new_arguments.values.select { |arg| !old_arguments[arg.graphql_name] }
         end
 
         def each_common_argument(&block)

data/lib/graphql/schema_comparator/diff/field.rb

@@ -24,7 +24,7 @@ module GraphQL
             changes << Changes::FieldDeprecationChanged.new(new_type, old_field, new_field)
           end
 
-          if old_field.type != new_field.type
+          if old_field.type.to_type_signature != new_field.type.to_type_signature
             changes << Changes::FieldTypeChanged.new(new_type, old_field, new_field)
           end
 
@@ -51,12 +51,12 @@ module GraphQL
         )
 
         def arg_removals
-          removed = old_arguments.values.select { |arg| !new_arguments[arg.name] }
+          removed = old_arguments.values.select { |arg| !new_arguments[arg.graphql_name] }
           removed.map { |arg| Changes::FieldArgumentRemoved.new(new_type, old_field, arg) }
         end
 
         def arg_additions
-          removed = new_arguments.values.select { |arg| !old_arguments[arg.name] }
+          removed = new_arguments.values.select { |arg| !old_arguments[arg.graphql_name] }
           removed.map { |arg| Changes::FieldArgumentAdded.new(new_type, new_field, arg) }
         end
 

data/lib/graphql/schema_comparator/diff/input_field.rb

@@ -21,7 +21,7 @@ module GraphQL
             changes << Changes::InputFieldDefaultChanged.new(old_type, old_field, new_field)
           end
 
-          if old_field.type != new_field.type
+          if old_field.type.to_type_signature != new_field.type.to_type_signature
             changes << Changes::InputFieldTypeChanged.new(old_type, old_field, new_field)
           end
 

data/lib/graphql/schema_comparator/diff/input_object.rb

@@ -39,11 +39,11 @@ module GraphQL
         end
 
         def removed_fields
-          old_fields.values.select { |field| !new_fields[field.name] }
+          old_fields.values.select { |field| !new_fields[field.graphql_name] }
         end
 
         def added_fields
-          new_fields.values.select { |field| !old_fields[field.name] }
+          new_fields.values.select { |field| !old_fields[field.graphql_name] }
         end
       end
     end

data/lib/graphql/schema_comparator/diff/interface.rb

@@ -2,12 +2,12 @@ module GraphQL
   module SchemaComparator
     module Diff
       class Interface
-        def initialize(old_iface, new_iface)
-          @old_iface = old_iface
-          @new_iface = new_iface
+        def initialize(old_interface, new_interface)
+          @old_interface = old_interface
+          @new_interface = new_interface
 
-          @old_fields = old_iface.fields
-          @new_fields = new_iface.fields
+          @old_fields = old_interface.fields
+          @new_fields = new_interface.fields
         end
 
         def diff
@@ -16,7 +16,7 @@ module GraphQL
           changes += field_additions
 
           each_common_field do |old_field, new_field|
-            changes += Diff::Field.new(old_iface, new_iface, old_field, new_field).diff
+            changes += Diff::Field.new(old_interface, new_interface, old_field, new_field).diff
           end
 
           changes
@@ -24,23 +24,23 @@ module GraphQL
 
         private
 
-        attr_reader :old_iface, :new_iface, :old_fields, :new_fields
+        attr_reader :old_interface, :new_interface, :old_fields, :new_fields
 
         def field_removals
-          removed = old_fields.values.select { |field| !new_fields[field.name] }
-          removed.map { |field| Changes::FieldRemoved.new(old_iface, field) }
+          removed = old_fields.values.select { |field| !new_fields[field.graphql_name] }
+          removed.map { |field| Changes::FieldRemoved.new(old_interface, field) }
         end
 
         def field_additions
-          added = new_fields.values.select { |field| !old_fields[field.name] }
-          added.map { |field| Changes::FieldAdded.new(new_iface, field) }
+          added = new_fields.values.select { |field| !old_fields[field.graphql_name] }
+          added.map { |field| Changes::FieldAdded.new(new_interface, field) }
         end
 
         def each_common_field(&block)
           intersection = old_fields.keys & new_fields.keys
           intersection.each do |common_field|
-            old_field = old_iface.fields[common_field]
-            new_field = new_iface.fields[common_field]
+            old_field = old_interface.fields[common_field]
+            new_field = new_interface.fields[common_field]
 
             block.call(old_field, new_field)
           end

data/lib/graphql/schema_comparator/diff/object_type.rb

@@ -40,22 +40,26 @@ module GraphQL
         )
 
         def interface_removals
-          removed = old_interfaces.select { |iface| !new_interfaces.include?(iface) }
-          removed.map { |iface| Changes::ObjectTypeInterfaceRemoved.new(iface, old_type) }
+          removed = filter_interfaces(old_interfaces, new_interfaces)
+          removed.map { |interface| Changes::ObjectTypeInterfaceRemoved.new(interface, old_type) }
         end
 
         def interface_additions
-          added = new_interfaces.select { |iface| !old_interfaces.include?(iface) }
-          added.map { |iface| Changes::ObjectTypeInterfaceAdded.new(iface, new_type) }
+          added = filter_interfaces(new_interfaces, old_interfaces)
+          added.map { |interface| Changes::ObjectTypeInterfaceAdded.new(interface, new_type) }
+        end
+
+        def filter_interfaces(interfaces, excluded_interfaces)
+          interfaces.select { |interface| !excluded_interfaces.map(&:graphql_name).include?(interface.graphql_name) }
         end
 
         def field_removals
-          removed = old_fields.values.select { |field| !new_fields[field.name] }
+          removed = old_fields.values.select { |field| !new_fields[field.graphql_name] }
           removed.map { |field| Changes::FieldRemoved.new(old_type, field) }
         end
 
         def field_additions
-          added = new_fields.values.select { |field| !old_fields[field.name] }
+          added = new_fields.values.select { |field| !old_fields[field.graphql_name] }
           added.map { |field| Changes::FieldAdded.new(new_type, field) }
         end
 

data/lib/graphql/schema_comparator/diff/schema.rb

@@ -40,16 +40,16 @@ module GraphQL
           if old_type.kind != new_type.kind
             changes << Changes::TypeKindChanged.new(old_type, new_type)
           else
-            case old_type
-            when GraphQL::EnumType
+            case old_type.kind.name
+            when "ENUM"
               changes += Diff::Enum.new(old_type, new_type).diff
-            when GraphQL::UnionType
+            when "UNION"
               changes += Diff::Union.new(old_type, new_type).diff
-            when GraphQL::InputObjectType
+            when "INPUT_OBJECT"
               changes += Diff::InputObject.new(old_type, new_type).diff
-            when GraphQL::ObjectType
+            when "OBJECT"
               changes += Diff::ObjectType.new(old_type, new_type).diff
-            when GraphQL::InterfaceType
+            when "INTERFACE"
               changes += Diff::Interface.new(old_type, new_type).diff
             end
           end
@@ -64,15 +64,15 @@ module GraphQL
         def changes_in_schema
           changes = []
 
-          if old_schema.query != new_schema.query
+          if old_schema.query&.graphql_name != new_schema.query&.graphql_name
             changes << Changes::SchemaQueryTypeChanged.new(old_schema, new_schema)
           end
 
-          if old_schema.mutation != new_schema.mutation
+          if old_schema.mutation&.graphql_name != new_schema.mutation&.graphql_name
             changes << Changes::SchemaMutationTypeChanged.new(old_schema, new_schema)
           end
 
-          if old_schema.subscription != new_schema.subscription
+          if old_schema.subscription&.graphql_name != new_schema.subscription&.graphql_name
             changes << Changes::SchemaSubscriptionTypeChanged.new(old_schema, new_schema)
           end
 

data/lib/graphql/schema_comparator/diff/union.rb

@@ -26,11 +26,15 @@ module GraphQL
         attr_reader :old_type, :new_type, :old_possible_types, :new_possible_types
 
         def removed_possible_types
-          old_possible_types.select { |type| !new_possible_types.include?(type) }
+          filter_types(old_possible_types, new_possible_types)
         end
 
         def added_possible_types
-          new_possible_types.select { |type| !old_possible_types.include?(type) }
+          filter_types(new_possible_types, old_possible_types)
+        end
+
+        def filter_types(types, exclude_types)
+          types.select { |type| !exclude_types.map(&:graphql_name).include?(type.graphql_name) }
         end
       end
     end

data/lib/graphql/schema_comparator/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module SchemaComparator
-    VERSION = "0.6.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/graphql/schema_comparator.rb

@@ -35,7 +35,7 @@ module GraphQL
     private
 
     def self.parse_schema(schema)
-      if schema.is_a?(GraphQL::Schema)
+      if schema.respond_to?(:ancestors) && schema.ancestors.include?(GraphQL::Schema)
         schema
       elsif schema.is_a?(String)
         GraphQL::Schema.from_definition(schema)

metadata

@@ -1,55 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: graphql-schema_comparator
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Marc-Andre Giroux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.19'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
@@ -94,7 +106,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: GraphQL::SchemaComparator compares two GraphQL schemas given their IDL
+description: GraphQL::SchemaComparator compares two GraphQL schemas given their SDL
   and returns a list of changes.
 email:
 - mgiroux0@gmail.com
@@ -104,8 +116,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -116,6 +128,9 @@ files:
 - bin/graphql-schema
 - bin/schema_comparator
 - bin/setup
+- gemfiles/graphql-head.gemfile
+- gemfiles/graphql1.10.gemfile
+- gemfiles/graphql1.13.gemfile
 - graphql-schema_comparator.gemspec
 - lib/graphql/schema_comparator.rb
 - lib/graphql/schema_comparator/changes.rb
@@ -126,7 +141,6 @@ files:
 - lib/graphql/schema_comparator/diff/directive_argument.rb
 - lib/graphql/schema_comparator/diff/enum.rb
 - lib/graphql/schema_comparator/diff/field.rb
-- lib/graphql/schema_comparator/diff/has_directives.rb
 - lib/graphql/schema_comparator/diff/input_field.rb
 - lib/graphql/schema_comparator/diff/input_object.rb
 - lib/graphql/schema_comparator/diff/interface.rb
@@ -136,10 +150,14 @@ files:
 - lib/graphql/schema_comparator/result.rb
 - lib/graphql/schema_comparator/version.rb
 - schema.graphql
-homepage: http://mgiroux.me
+homepage: https://github.com/xuorig/graphql-schema_comparator
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/xuorig/graphql-schema_comparator
+  changelog_uri: https://github.com/xuorig/graphql-schema_comparator/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/xuorig/graphql-schema_comparator
+  bug_tracker_uri: https://github.com/xuorig/graphql-schema_comparator/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -155,8 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Compare GraphQL schemas and get the changes that happened.

data/.travis.yml

@@ -1,10 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-before_install:
-  - gem update --system --no-doc
-  - gem install bundler
-rvm:
-- 2.3.4
-- 2.4.1