graphql-schema_comparator 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b2c5111538092113b88552e2d85930eea51b4c0
-  data.tar.gz: 3a3b4d43916961515caa915c51e0c0b0370c1395
+  metadata.gz: fb19e37d9e3d7037094e788cce01bd91fe88fbe6
+  data.tar.gz: dd33278458a8405503abf0c34b8fbd6fb565a5c5
 SHA512:
-  metadata.gz: 00c6e2702e8bb9c1f34b1d9a777a3b63cc0cb6f56aa78f76bf14c04aee0997e6e690f79de956d46da31be9298a98ff72413d5cd77f18b514cd0b6b8a02021f76
-  data.tar.gz: b74179eb8941cf2985f9dda75219b28b001e4c771db5db3d49e380cc98bc94c625d720dd7bf4cb88ddef6e51672b0a50b136b92da3e6dbfc6af3c13874e8c65f
+  metadata.gz: 5a6592586307a89a97e5d62dcf623310a8d09c4dd9c4c5a496f9556649cbb56ecdc3c4a2de97494e27b5c04d9e97a816e8e02a20e52a532f7fc672165f13af69
+  data.tar.gz: a4c7eaf05826ce093c6772a7a3aa024e73d44b2df7dad968e4ae161188fbbe9dfaec608a6e78e242ebc350ddb55be5d271412d0548aa64dcae65a4072f764fcb

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 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

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

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "graphql", "~> 1.6"
-  spec.add_dependency "thor", "~> 0.19"
+  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.rb

@@ -45,7 +45,9 @@ 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
@@ -80,7 +82,9 @@ 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
@@ -98,7 +102,9 @@ 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
@@ -116,7 +122,9 @@ 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
@@ -134,7 +142,9 @@ 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
@@ -153,7 +163,9 @@ 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
@@ -207,7 +219,17 @@ 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
@@ -243,7 +265,9 @@ 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
@@ -274,7 +298,7 @@ module GraphQL
           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
 
@@ -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
@@ -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
@@ -552,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
@@ -575,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

data/lib/graphql/schema_comparator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-schema_comparator
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Marc-Andre Giroux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2019-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -28,28 +28,34 @@ dependencies:
   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