graphql-schema_comparator 0.5.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2bd04f7cdf16f7bc67fb74e219478457b180e022
-  data.tar.gz: eb021f9745da0a4fed5fb2cedfb5a848ca1685b0
+SHA256:
+  metadata.gz: 3ae1770b6fad8e77502e03cb613fbc5bf5546bc96d535e2af0f622c2794102c0
+  data.tar.gz: 5edcad6f5ce2fea8a2e83c79279e4bee868d5e3507af254176931341d7d46506
 SHA512:
-  metadata.gz: 7a6d826fd10f0bb42eebcc9546c77d40b32242d5c6888181e5dab77b7c1f9d4ce8d4be192ef750209d98d7230ee81aa0121645f6c1482b6fc1d80e9d5287f02e
-  data.tar.gz: f43508482f55b5b88b1627b5b9d12ce6800512a2386cb66785348f01951d25384d1142d62370dc7d339530d0593998200005ced1a4ae01402a24940676bbc62d
+  metadata.gz: e10aae6486a79da4eb4e9fb6e3787ac166d5d54848bf2eea37b8885839c83efe8de97af8dc84fa732d7c1582567050b0469fba5d546a85b9183b6ccdcb4582a2
+  data.tar.gz: 1a879654fecfb43824872cf9c4907d4edaa221645d6d91a062b7f933cb0cf0ce43587e6d840451f7027b9da8aed99c45fd8d0af84bc3403901c6a93eb2764cb4

data/.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: Tests
+
+on:
+  push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.7, '3.0']
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle install
+    - run: bundle exec rake

data/CHANGELOG.md

@@ -1,8 +1,39 @@
 # Changelog
 
+## 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
+
+  - Add `#path` which returns a dot-delimited path to the affected schema member. (#15)
+
+## 0.5.1 (Feb 15th 2018)
+
+### Bug Fix
+
+  - Return a better message when adding a default value, if this one was nil before.
+
 ## 0.5.0 (Dec 2 2017)
 
-## New Features
+### New Features
 
   - `AbstractChange#criticality` now returns a criticality object which
   has a level (non_breaking, dangerous, breaking) and a reason
@@ -13,14 +44,14 @@
 
   - New CLI `schema_comparator` which includes `dangerous_changes`
 
-## Breaking Changes
+### Breaking Changes
 
   - Some changes have been recategorized as dangerous
   - Some type changes now return breaking or non-breaking depending on the type kind
 
 ## 0.4.0 (Nov 27 2017)
 
-## Breaking Changes
+### Breaking Changes
 
   - Argument and InputValue type changes are considered non
     breaking if type goes from Null => Non-Null
@@ -36,32 +67,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

@@ -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/graphql-schema_comparator.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   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"
+  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.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)

data/lib/graphql/schema_comparator/changes.rb

@@ -12,7 +12,7 @@ module GraphQL
           raise NotImplementedError
         end
 
-      # @return [Boolean] If the change is breaking or not
+        # @return [Boolean] If the change is breaking or not
         def breaking?
           criticality.breaking?
         end
@@ -31,6 +31,11 @@ module GraphQL
         def criticality
           raise NotImplementedError
         end
+
+        # @return [String] Dot-delimited path to the affected schema member.
+        def path
+          raise NotImplementedError
+        end
       end
 
       # Mostly breaking changes
@@ -40,11 +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
-          "`#{removed_type.name}` was removed"
+          "Type `#{removed_type.graphql_definition}` was removed"
+        end
+
+        def path
+          removed_type.graphql_definition.to_s
         end
       end
 
@@ -57,7 +68,11 @@ module GraphQL
         end
 
         def message
-          "`#{directive.name}` was removed"
+          "Directive `#{directive.graphql_name}` was removed"
+        end
+
+        def path
+          "@#{directive.graphql_name}"
         end
       end
 
@@ -67,11 +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_definition}` kind changed from `#{old_type.kind}` to `#{new_type.kind}`"
+        end
+
+        def path
+          old_type.graphql_definition.to_s
         end
       end
 
@@ -81,11 +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_definition}`"
+        end
+
+        def path
+          [enum_type.graphql_definition, enum_value.graphql_name].join('.')
         end
       end
 
@@ -95,11 +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_definition}`"
+        end
+
+        def path
+          union_type.graphql_definition.to_s
         end
       end
 
@@ -109,11 +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_definition}`"
+        end
+
+        def path
+          [input_object_type.graphql_definition, field.graphql_name].join('.')
         end
       end
 
@@ -124,11 +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_definition}` was removed from field `#{object_type.graphql_definition}.#{field.graphql_name}`"
+        end
+
+        def path
+          [object_type.graphql_definition, field.graphql_name, argument.graphql_name].join('.')
         end
       end
 
@@ -142,7 +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.graphql_name}", argument.graphql_name].join('.')
         end
       end
 
@@ -156,7 +205,11 @@ 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
+          # TODO
         end
       end
 
@@ -166,11 +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_definition}`"
+        end
+
+        def path
+          [object_type.graphql_definition, field.graphql_name].join('.')
         end
       end
 
@@ -184,7 +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.graphql_name}"
         end
       end
 
@@ -194,11 +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_definition}` object type no longer implements `#{interface.graphql_name}` interface"
+        end
+
+        def path
+          object_type.graphql_definition.to_s
         end
       end
 
@@ -214,16 +291,20 @@ module GraphQL
         end
 
         def message
-          "Field `#{type}.#{old_field.name}` changed type from `#{old_field.type}` to `#{new_field.type}`"
+          "Field `#{type.graphql_definition}.#{old_field.graphql_name}` changed type from `#{old_field.type.graphql_definition}` to `#{new_field.type.graphql_definition}`"
         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.graphql_definition, old_field.graphql_name].join('.')
+        end
       end
 
       class InputFieldTypeChanged < AbstractChange
@@ -237,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
@@ -246,7 +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 `#{input_type.graphql_definition}.#{old_input_field.graphql_name}` changed type from `#{old_input_field.type.graphql_definition}` to `#{new_input_field.type.graphql_definition}`"
+        end
+
+        def path
+          [input_type.graphql_definition, old_input_field.graphql_name].join('.')
         end
       end
 
@@ -261,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
@@ -271,8 +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 `#{type.graphql_definition}.#{field.graphql_definition.name}` changed"\
+            " from `#{old_argument.type.graphql_definition}` to `#{new_argument.type.graphql_definition}`"
+        end
+
+        def path
+          [type.graphql_definition, field.graphql_definition.name, old_argument.graphql_name].join('.')
         end
       end
 
@@ -296,8 +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.graphql_definition}` to `#{new_argument.type.graphql_definition}`"
+        end
+
+        def path
+          ["@#{directive.graphql_name}", old_argument.graphql_name].join('.')
         end
       end
 
@@ -313,6 +410,10 @@ module GraphQL
         def message
           "Schema mutation root has changed from `#{old_schema.mutation}` to `#{new_schema.mutation}`"
         end
+
+        def path
+          # TODO
+        end
       end
 
       class SchemaSubscriptionTypeChanged < AbstractChange
@@ -327,6 +428,10 @@ module GraphQL
         def message
           "Schema subscription type has changed from `#{old_schema.subscription}` to `#{new_schema.subscription}`"
         end
+
+        def path
+          # TODO
+        end
       end
 
       # Dangerous Changes
@@ -346,8 +451,16 @@ module GraphQL
         end
 
         def message
-          "Default value for argument `#{new_argument.name}` on field `#{type.name}.#{field.name}` changed"\
-            " from `#{old_argument.default_value}` to `#{new_argument.default_value}`"
+          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 `#{type.graphql_definition}.#{field.graphql_name}`"
+          else
+            "Default value for argument `#{new_argument.graphql_name}` on field `#{type.graphql_definition}.#{field.name}` changed"\
+              " from `#{old_argument.default_value}` to `#{new_argument.default_value}`"
+          end
+        end
+
+        def path
+          [type.graphql_definition, field.graphql_name, old_argument.graphql_name].join('.')
         end
       end
 
@@ -365,9 +478,13 @@ module GraphQL
         end
 
         def message
-          "Input field `#{input_type.name}.#{old_field.name}` default changed"\
+          "Input field `#{input_type.graphql_definition}.#{old_field.graphql_name}` default changed"\
             " from `#{old_field.default_value}` to `#{new_field.default_value}`"
         end
+
+        def path
+          [input_type.graphql_definition, old_field.graphql_name].join(".")
+        end
       end
 
       class DirectiveArgumentDefaultChanged < AbstractChange
@@ -384,9 +501,13 @@ 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.graphql_name}", new_argument.graphql_name].join(".")
+        end
       end
 
       class EnumValueAdded < AbstractChange
@@ -402,7 +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_definition}`"
+        end
+
+        def path
+          [enum_type.graphql_definition, enum_value.graphql_name].join(".")
         end
       end
 
@@ -419,7 +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_definition}`"
+        end
+
+        def path
+          union_type.graphql_definition.to_s
         end
       end
 
@@ -436,7 +565,11 @@ module GraphQL
         end
 
         def message
-          "`#{object_type.name}` object implements `#{interface.name}` interface"
+          "`#{object_type.graphql_definition}` object implements `#{interface.graphql_name}` interface"
+        end
+
+        def path
+          object_type.graphql_definition.to_s
         end
       end
 
@@ -447,7 +580,7 @@ module GraphQL
 
         def initialize(input_object_type, field)
           @criticality = if field.type.non_null?
-            Changes::Criticality.breaking
+            Changes::Criticality.breaking(reason: "Adding a non-null field 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
@@ -457,7 +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_definition}`"
+        end
+
+        def path
+          [input_object_type.graphql_definition, field.graphql_name].join(".")
         end
       end
 
@@ -466,7 +603,7 @@ module GraphQL
 
         def initialize(type, field, argument)
           @criticality = if argument.type.non_null?
-            Changes::Criticality.breaking
+            Changes::Criticality.breaking(reason: "Adding a required argument 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
@@ -477,7 +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_definition}` added to field `#{type.graphql_definition}.#{field.graphql_name}`"
+        end
+
+        def path
+          [type.graphql_definition, field.graphql_name, argument.graphql_name].join(".")
         end
       end
 
@@ -490,7 +631,11 @@ module GraphQL
         end
 
         def message
-          "Type `#{type.name}` was added"
+          "Type `#{type.graphql_definition}` was added"
+        end
+
+        def path
+          type.graphql_definition.to_s
         end
       end
 
@@ -503,7 +648,11 @@ module GraphQL
         end
 
         def message
-          "Directive `#{directive.name}` was added"
+          "Directive `#{directive.graphql_name}` was added"
+        end
+
+        def path
+          "@#{directive.graphql_name}"
         end
       end
 
@@ -517,7 +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_definition}` has changed to `#{new_type.description}`"
+        end
+
+        def path
+          old_type.graphql_definition.to_s
         end
       end
 
@@ -532,9 +685,13 @@ module GraphQL
         end
 
         def message
-          "Description for enum value `#{enum.name}.#{new_enum_value.name}` changed from " \
+          "Description for enum value `#{enum.graphql_name}.#{new_enum_value.graphql_name}` changed from " \
             "`#{old_enum_value.description}` to `#{new_enum_value.description}`"
         end
+
+        def path
+          [enum.graphql_name, old_enum_value.graphql_name].join(".")
+        end
       end
 
       class EnumValueDeprecated < AbstractChange
@@ -549,13 +706,17 @@ module GraphQL
 
         def message
           if old_enum_value.deprecation_reason
-            "Enum value `#{enum.name}.#{new_enum_value.name}` deprecation reason changed " \
+            "Enum value `#{enum.graphql_name}.#{new_enum_value.graphql_name}` 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" \
+            "Enum value `#{enum.graphql_name}.#{new_enum_value.graphql_name}` was deprecated with reason" \
               " `#{new_enum_value.deprecation_reason}`"
           end
         end
+
+        def path
+          [enum.graphql_name, old_enum_value.graphql_name].join(".")
+        end
       end
 
       class InputFieldDescriptionChanged < AbstractChange
@@ -569,9 +730,13 @@ module GraphQL
         end
 
         def message
-          "Input field `#{input_type.name}.#{old_field.name}` description changed"\
+          "Input field `#{input_type.graphql_definition}.#{old_field.graphql_name}` description changed"\
             " from `#{old_field.description}` to `#{new_field.description}`"
         end
+
+        def path
+          [input_type.graphql_definition, old_field.graphql_name].join(".")
+        end
       end
 
       class DirectiveDescriptionChanged < AbstractChange
@@ -584,9 +749,13 @@ 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.graphql_name}"
+        end
       end
 
       class FieldDescriptionChanged < AbstractChange
@@ -600,9 +769,13 @@ module GraphQL
         end
 
         def message
-          "Field `#{type.name}.#{old_field.name}` description changed"\
+          "Field `#{type.graphql_definition}.#{old_field.graphql_name}` description changed"\
             " from `#{old_field.description}` to `#{new_field.description}`"
         end
+
+        def path
+          [type.graphql_definition, old_field.graphql_name].join(".")
+        end
       end
 
       class FieldArgumentDescriptionChanged < AbstractChange
@@ -617,9 +790,13 @@ 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 `#{type.graphql_definition}.#{field.graphql_name}` changed"\
             " from `#{old_argument.description}` to `#{new_argument.description}`"
         end
+
+        def path
+          [type.graphql_definition, field.graphql_name, old_argument.graphql_name].join(".")
+        end
       end
 
       class DirectiveArgumentDescriptionChanged < AbstractChange
@@ -633,9 +810,13 @@ 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.graphql_name}", old_argument.graphql_name].join(".")
+        end
       end
 
       class FieldDeprecationChanged < AbstractChange
@@ -649,9 +830,13 @@ module GraphQL
         end
 
         def message
-          "Deprecation reason on field `#{type.name}.#{new_field.name}` has changed "\
+          "Deprecation reason on field `#{type.graphql_definition}.#{new_field.graphql_name}` has changed "\
             "from `#{old_field.deprecation_reason}` to `#{new_field.deprecation_reason}`"
         end
+
+        def path
+          [type.graphql_definition, old_field.graphql_name].join(".")
+        end
       end
 
       class FieldAdded < AbstractChange
@@ -664,9 +849,12 @@ 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_definition}`"
         end
 
+        def path
+          [object_type.graphql_definition, field.graphql_name].join(".")
+        end
       end
 
       class DirectiveLocationAdded < AbstractChange
@@ -679,7 +867,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.graphql_name}"
         end
       end
 
@@ -841,7 +1033,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.graphql_definition != new_arg.type.graphql_definition
             changes << Changes::FieldArgumentTypeChanged.new(type, field, old_arg, new_arg)
           end
 

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

@@ -49,8 +49,8 @@ module GraphQL
         def each_common_argument(&block)
           intersection = old_arguments.keys & new_arguments.keys
           intersection.each do |common_arg|
-            old_arg = new_directive.arguments[common_arg]
-            new_arg = old_directive.arguments[common_arg]
+            old_arg = old_directive.arguments[common_arg]
+            new_arg = new_directive.arguments[common_arg]
 
             block.call(old_arg, new_arg)
           end

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

@@ -19,7 +19,7 @@ module GraphQL
             changes << Changes::DirectiveArgumentDefaultChanged.new(directive, old_arg, new_arg)
           end
 
-          if old_arg.type != new_arg.type
+          if old_arg.type.graphql_definition != new_arg.type.graphql_definition
             changes << Changes::DirectiveArgumentTypeChanged.new(directive, old_arg, new_arg)
           end
 

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.graphql_definition != new_field.type.graphql_definition
             changes << Changes::FieldTypeChanged.new(new_type, old_field, new_field)
           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.graphql_definition != new_field.type.graphql_definition
             changes << Changes::InputFieldTypeChanged.new(old_type, old_field, new_field)
           end
 

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

@@ -3,8 +3,8 @@ module GraphQL
     module Diff
       class ObjectType
         def initialize(old_type, new_type)
-          @old_type = old_type
-          @new_type = new_type
+          @old_type = old_type.graphql_definition
+          @new_type = new_type.graphql_definition
 
           @old_fields = old_type.fields
           @new_fields = new_type.fields
@@ -40,15 +40,19 @@ module GraphQL
         )
 
         def interface_removals
-          removed = old_interfaces.select { |iface| !new_interfaces.include?(iface) }
+          removed = filter_interfaces(old_interfaces, new_interfaces)
           removed.map { |iface| Changes::ObjectTypeInterfaceRemoved.new(iface, old_type) }
         end
 
         def interface_additions
-          added = new_interfaces.select { |iface| !old_interfaces.include?(iface) }
+          added = filter_interfaces(new_interfaces, old_interfaces)
           added.map { |iface| Changes::ObjectTypeInterfaceAdded.new(iface, new_type) }
         end
 
+        def filter_interfaces(interfaces, excluded_interfaces)
+          interfaces.select { |interface| !excluded_interfaces.map(&:graphql_definition).include?(interface.graphql_definition) }
+        end
+
         def field_removals
           removed = old_fields.values.select { |field| !new_fields[field.name] }
           removed.map { |field| Changes::FieldRemoved.new(old_type, field) }

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

@@ -40,7 +40,7 @@ module GraphQL
           if old_type.kind != new_type.kind
             changes << Changes::TypeKindChanged.new(old_type, new_type)
           else
-            case old_type
+            case old_type.graphql_definition
             when GraphQL::EnumType
               changes += Diff::Enum.new(old_type, new_type).diff
             when GraphQL::UnionType
@@ -64,15 +64,15 @@ module GraphQL
         def changes_in_schema
           changes = []
 
-          if old_schema.query != new_schema.query
+          if old_schema.query&.to_graphql != new_schema.query&.to_graphql
             changes << Changes::SchemaQueryTypeChanged.new(old_schema, new_schema)
           end
 
-          if old_schema.mutation != new_schema.mutation
+          if old_schema.mutation&.to_graphql != new_schema.mutation&.to_graphql
             changes << Changes::SchemaMutationTypeChanged.new(old_schema, new_schema)
           end
 
-          if old_schema.subscription != new_schema.subscription
+          if old_schema.subscription&.to_graphql != new_schema.subscription&.to_graphql
             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_definition).include?(type.graphql_definition) }
         end
       end
     end

data/lib/graphql/schema_comparator/version.rb

@@ -1,5 +1,5 @@
 module GraphQL
   module SchemaComparator
-    VERSION = "0.5.0"
+    VERSION = "1.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-schema_comparator
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Marc-Andre Giroux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-02 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -16,40 +16,46 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.10'
 - !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
@@ -104,8 +110,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -155,8 +161,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
 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