graphql-schema_comparator 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0706d1728e914ffaf9626d34a88bef2865938415
-  data.tar.gz: 1e8c4c1fdd0de7a0fa5458ab0f7505c85bfa4335
+  metadata.gz: 3b2c5111538092113b88552e2d85930eea51b4c0
+  data.tar.gz: 3a3b4d43916961515caa915c51e0c0b0370c1395
 SHA512:
-  metadata.gz: 82a98d283e5a9efcb12205be3654936614b858a3813f93134343c32672d5691abac3411875cd18b6ef0f841e91a35fa620ceddc4a2500f51be1af0861c9d82d5
-  data.tar.gz: c78a997c5280e781ad000e1434d85ba783756b1554423572cf7cbb4476f6d776ab7df4e5781183e603ccd242c770bcca1320e1179b88db2fee27f106efc4cf8a
+  metadata.gz: 00c6e2702e8bb9c1f34b1d9a777a3b63cc0cb6f56aa78f76bf14c04aee0997e6e690f79de956d46da31be9298a98ff72413d5cd77f18b514cd0b6b8a02021f76
+  data.tar.gz: b74179eb8941cf2985f9dda75219b28b001e4c771db5db3d49e380cc98bc94c625d720dd7bf4cb88ddef6e51672b0a50b136b92da3e6dbfc6af3c13874e8c65f

data/CHANGELOG.md

@@ -1,14 +1,20 @@
 # Changelog
 
+## 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
+### 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
@@ -19,14 +25,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

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
@@ -44,7 +49,11 @@ module GraphQL
         end
 
         def message
-          "`#{removed_type.name}` was removed"
+          "Type `#{removed_type.name}` was removed"
+        end
+
+        def path
+          removed_type.name
         end
       end
 
@@ -57,7 +66,11 @@ module GraphQL
         end
 
         def message
-          "`#{directive.name}` was removed"
+          "Directive `#{directive.name}` was removed"
+        end
+
+        def path
+          "@#{directive.name}"
         end
       end
 
@@ -73,6 +86,10 @@ module GraphQL
         def message
           "`#{old_type.name}` kind changed from `#{old_type.kind}` to `#{new_type.kind}`"
         end
+
+        def path
+          old_type.name
+        end
       end
 
       class EnumValueRemoved < AbstractChange
@@ -87,6 +104,10 @@ module GraphQL
         def message
           "Enum value `#{enum_value.name}` was removed from enum `#{enum_type.name}`"
         end
+
+        def path
+          [enum_type.name, enum_value.name].join('.')
+        end
       end
 
       class UnionMemberRemoved < AbstractChange
@@ -101,6 +122,10 @@ module GraphQL
         def message
           "Union member `#{union_member.name}` was removed from Union type `#{union_type.name}`"
         end
+
+        def path
+          union_type.name
+        end
       end
 
       class InputFieldRemoved < AbstractChange
@@ -115,6 +140,10 @@ module GraphQL
         def message
           "Input field `#{field.name}` was removed from input object type `#{input_object_type.name}`"
         end
+
+        def path
+          [input_object_type.name, field.name].join('.')
+        end
       end
 
       class FieldArgumentRemoved < AbstractChange
@@ -130,6 +159,10 @@ module GraphQL
         def message
           "Argument `#{argument.name}: #{argument.type}` was removed from field `#{object_type.name}.#{field.name}`"
         end
+
+        def path
+          [object_type.name, field.name, argument.name].join('.')
+        end
       end
 
       class DirectiveArgumentRemoved < AbstractChange
@@ -144,6 +177,10 @@ module GraphQL
         def message
           "Argument `#{argument.name}` was removed from directive `#{directive.name}`"
         end
+
+        def path
+          ["@#{directive.name}", argument.name].join('.')
+        end
       end
 
       class SchemaQueryTypeChanged < AbstractChange
@@ -158,6 +195,10 @@ module GraphQL
         def message
           "Schema query root has changed from `#{old_schema.query.name}` to `#{new_schema.query.name}`"
         end
+
+        def path
+          # TODO
+        end
       end
 
       class FieldRemoved < AbstractChange
@@ -172,6 +213,10 @@ module GraphQL
         def message
           "Field `#{field.name}` was removed from object type `#{object_type.name}`"
         end
+
+        def path
+          [object_type.name, field.name].join('.')
+        end
       end
 
       class DirectiveLocationRemoved < AbstractChange
@@ -186,6 +231,10 @@ module GraphQL
         def message
           "Location `#{location}` was removed from directive `#{directive.name}`"
         end
+
+        def path
+          "@#{directive.name}"
+        end
       end
 
       class ObjectTypeInterfaceRemoved < AbstractChange
@@ -200,6 +249,10 @@ module GraphQL
         def message
           "`#{object_type.name}` object type no longer implements `#{interface.name}` interface"
         end
+
+        def path
+          object_type.name
+        end
       end
 
       class FieldTypeChanged < AbstractChange
@@ -224,6 +277,10 @@ module GraphQL
             Changes::Criticality.breaking
           end
         end
+
+        def path
+          [type.name, old_field.name].join('.')
+        end
       end
 
       class InputFieldTypeChanged < AbstractChange
@@ -248,6 +305,10 @@ module GraphQL
         def message
           "Input field `#{input_type}.#{old_input_field.name}` changed type from `#{old_input_field.type}` to `#{new_input_field.type}`"
         end
+
+        def path
+          [input_type.name, old_input_field.name].join('.')
+        end
       end
 
       class FieldArgumentTypeChanged < AbstractChange
@@ -274,6 +335,10 @@ module GraphQL
           "Type for argument `#{new_argument.name}` on field `#{type.name}.#{field.name}` changed"\
             " from `#{old_argument.type}` to `#{new_argument.type}`"
         end
+
+        def path
+          [type.name, field.name, old_argument.name].join('.')
+        end
       end
 
       class DirectiveArgumentTypeChanged < AbstractChange
@@ -299,6 +364,10 @@ module GraphQL
           "Type for argument `#{new_argument.name}` on directive `#{directive.name}` changed"\
             " from `#{old_argument.type}` to `#{new_argument.type}`"
         end
+
+        def path
+          ["@#{directive.name}", old_argument.name].join('.')
+        end
       end
 
       class SchemaMutationTypeChanged < AbstractChange
@@ -313,6 +382,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 +400,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
@@ -353,6 +430,10 @@ module GraphQL
               " from `#{old_argument.default_value}` to `#{new_argument.default_value}`"
           end
         end
+
+        def path
+          [type.name, field.name, old_argument.name].join('.')
+        end
       end
 
       class InputFieldDefaultChanged < AbstractChange
@@ -372,6 +453,10 @@ module GraphQL
           "Input field `#{input_type.name}.#{old_field.name}` default changed"\
             " from `#{old_field.default_value}` to `#{new_field.default_value}`"
         end
+
+        def path
+          [input_type.name, old_field.name].join(".")
+        end
       end
 
       class DirectiveArgumentDefaultChanged < AbstractChange
@@ -391,6 +476,10 @@ module GraphQL
           "Default value for argument `#{new_argument.name}` on directive `#{directive.name}` changed"\
             " from `#{old_argument.default_value}` to `#{new_argument.default_value}`"
         end
+
+        def path
+          ["@#{directive.name}", new_argument.name].join(".")
+        end
       end
 
       class EnumValueAdded < AbstractChange
@@ -408,6 +497,10 @@ module GraphQL
         def message
           "Enum value `#{enum_value.name}` was added to enum `#{enum_type.name}`"
         end
+
+        def path
+          [enum_type.name, enum_value.name].join(".")
+        end
       end
 
       class UnionMemberAdded < AbstractChange
@@ -425,6 +518,10 @@ module GraphQL
         def message
           "Union member `#{union_member.name}` was added to Union type `#{union_type.name}`"
         end
+
+        def path
+          union_type.name
+        end
       end
 
       class ObjectTypeInterfaceAdded < AbstractChange
@@ -442,6 +539,10 @@ module GraphQL
         def message
           "`#{object_type.name}` object implements `#{interface.name}` interface"
         end
+
+        def path
+          object_type.name
+        end
       end
 
       # Mostly Non-Breaking Changes
@@ -463,6 +564,10 @@ module GraphQL
         def message
           "Input field `#{field.name}` was added to input object type `#{input_object_type.name}`"
         end
+
+        def path
+          [input_object_type.name, field.name].join(".")
+        end
       end
 
       class FieldArgumentAdded < AbstractChange
@@ -483,6 +588,10 @@ module GraphQL
         def message
           "Argument `#{argument.name}: #{argument.type}` added to field `#{type.name}.#{field.name}`"
         end
+
+        def path
+          [type.name, field.name, argument.name].join(".")
+        end
       end
 
       class TypeAdded < AbstractChange
@@ -496,6 +605,10 @@ module GraphQL
         def message
           "Type `#{type.name}` was added"
         end
+
+        def path
+          type.name
+        end
       end
 
       class DirectiveAdded < AbstractChange
@@ -509,6 +622,10 @@ module GraphQL
         def message
           "Directive `#{directive.name}` was added"
         end
+
+        def path
+          "@#{directive.name}"
+        end
       end
 
       class TypeDescriptionChanged < AbstractChange
@@ -523,6 +640,10 @@ module GraphQL
         def message
           "Description `#{old_type.description}` on type `#{old_type.name}` has changed to `#{new_type.description}`"
         end
+
+        def path
+          old_type.name
+        end
       end
 
       class EnumValueDescriptionChanged < AbstractChange
@@ -539,6 +660,10 @@ module GraphQL
           "Description for enum value `#{enum.name}.#{new_enum_value.name}` changed from " \
             "`#{old_enum_value.description}` to `#{new_enum_value.description}`"
         end
+
+        def path
+          [enum.name, old_enum_value.name].join(".")
+        end
       end
 
       class EnumValueDeprecated < AbstractChange
@@ -560,6 +685,10 @@ module GraphQL
               " `#{new_enum_value.deprecation_reason}`"
           end
         end
+
+        def path
+          [enum.name, old_enum_value.name].join(".")
+        end
       end
 
       class InputFieldDescriptionChanged < AbstractChange
@@ -576,6 +705,10 @@ module GraphQL
           "Input field `#{input_type.name}.#{old_field.name}` description changed"\
             " from `#{old_field.description}` to `#{new_field.description}`"
         end
+
+        def path
+          [input_type.name, old_field.name].join(".")
+        end
       end
 
       class DirectiveDescriptionChanged < AbstractChange
@@ -591,6 +724,10 @@ module GraphQL
           "Directive `#{new_directive.name}` description changed"\
             " from `#{old_directive.description}` to `#{new_directive.description}`"
         end
+
+        def path
+          "@#{old_directive.name}"
+        end
       end
 
       class FieldDescriptionChanged < AbstractChange
@@ -607,6 +744,10 @@ module GraphQL
           "Field `#{type.name}.#{old_field.name}` description changed"\
             " from `#{old_field.description}` to `#{new_field.description}`"
         end
+
+        def path
+          [type.name, old_field.name].join(".")
+        end
       end
 
       class FieldArgumentDescriptionChanged < AbstractChange
@@ -624,6 +765,10 @@ module GraphQL
           "Description for argument `#{new_argument.name}` on field `#{type.name}.#{field.name}` changed"\
             " from `#{old_argument.description}` to `#{new_argument.description}`"
         end
+
+        def path
+          [type.name, field.name, old_argument.name].join(".")
+        end
       end
 
       class DirectiveArgumentDescriptionChanged < AbstractChange
@@ -640,6 +785,10 @@ module GraphQL
           "Description for argument `#{new_argument.name}` on directive `#{directive.name}` changed"\
             " from `#{old_argument.description}` to `#{new_argument.description}`"
         end
+
+        def path
+          ["@#{directive.name}", old_argument.name].join(".")
+        end
       end
 
       class FieldDeprecationChanged < AbstractChange
@@ -656,6 +805,10 @@ module GraphQL
           "Deprecation reason on field `#{type.name}.#{new_field.name}` has changed "\
             "from `#{old_field.deprecation_reason}` to `#{new_field.deprecation_reason}`"
         end
+
+        def path
+          [type.name, old_field.name].join(".")
+        end
       end
 
       class FieldAdded < AbstractChange
@@ -671,6 +824,9 @@ module GraphQL
           "Field `#{field.name}` was added to object type `#{object_type.name}`"
         end
 
+        def path
+          [object_type.name, field.name].join(".")
+        end
       end
 
       class DirectiveLocationAdded < AbstractChange
@@ -685,6 +841,10 @@ module GraphQL
         def message
           "Location `#{location}` was added to directive `#{directive.name}`"
         end
+
+        def path
+          "@#{directive.name}"
+        end
       end
 
       # TODO

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-schema_comparator
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Marc-Andre Giroux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql