graphql-schema_comparator 0.4.0 → 0.5.0

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

@@ -0,0 +1,88 @@
+module GraphQL
+  module SchemaComparator
+    module Changes
+      # Defines the criticality of a {Change} object.
+      class Criticality
+        # Non-breaking criticality usually defines changes that are always
+        # safe to make to a GraphQL Schema. They do not
+        # require any changes on the client side
+        NON_BREAKING = 1
+
+        # Dangerous criticality defines changes that are not breaking
+        # the schema, but may break runtime logic on clients
+        # if they did not code defensively enough to prevent
+        # these changes.
+        DANGEROUS = 2
+
+        # Breaking criticality are changes that immediatly impact
+        # clients usually causing queries not to be valid anymore.
+        BREAKING = 3
+
+        attr_reader :level, :reason
+
+        class << self
+          # Returns a new Criticality object with a BREAKING level
+          # @param reason [String] optional reason for this criticality
+          # @return [GraphQL::SchemaComparator::Changes::Criticality]
+          def breaking(reason: "This change is a breaking change")
+            new(
+              level: BREAKING,
+              reason: reason
+            )
+          end
+
+          # Returns a new Criticality object with a NON_BREAKING level
+          # @param reason [String] optional reason for this criticality
+          # @return [GraphQL::SchemaComparator::Changes::Criticality]
+          def non_breaking(reason: "This change is safe")
+            new(
+              level: NON_BREAKING,
+              reason: reason
+            )
+          end
+
+          # Returns a new Criticality object with a DANGEROUS level
+          # @param reason [String] optional reason for this criticality
+          # @return [GraphQL::SchemaComparator::Changes::Criticality]
+          def dangerous(reason: "This change is dangerous")
+            new(
+              level: DANGEROUS,
+              reason: reason
+            )
+          end
+        end
+
+        # Creates a new Criticality object
+        #
+        # @param level [Symbol] The criticality level
+        # @param reason [String] The reason why this criticality is set on the change
+        def initialize(level: NON_BREAKING, reason: nil)
+          @level = level
+          @reason = reason
+        end
+
+        def <=>(other)
+          if level == other.level
+            0
+          elsif level < other.level
+            -1
+          else
+            1
+          end
+        end
+
+        def breaking?
+          @level == BREAKING
+        end
+
+        def non_breaking?
+          @level == NON_BREAKING
+        end
+
+        def dangerous?
+          @level == DANGEROUS
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module GraphQL
+  module SchemaComparator
+    module Changes
+      module SafeTypeChange
+        def safe_change_for_field?(old_type, new_type)
+          if !old_type.kind.wraps? && !new_type.kind.wraps?
+            old_type == new_type
+          elsif new_type.kind.non_null?
+            of_type = old_type.kind.non_null? ? old_type.of_type : old_type
+            safe_change_for_field?(of_type, new_type.of_type)
+          elsif old_type.kind.list?
+            new_type.kind.list? && safe_change_for_field?(old_type.of_type, new_type.of_type) ||
+              new_type.kind.non_null? && safe_change_for_field?(old_type, new_type.of_type)
+          else
+            false
+          end
+        end
+
+        def safe_change_for_input_value?(old_type, new_type)
+          if !old_type.kind.wraps? && !new_type.kind.wraps?
+            old_type == new_type
+          elsif old_type.kind.list? && new_type.kind.list?
+            safe_change_for_input_value?(old_type.of_type, new_type.of_type)
+          elsif old_type.kind.non_null?
+            of_type = new_type.kind.non_null? ? new_type.of_type : new_type
+            safe_change_for_input_value?(old_type.of_type, of_type)
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/schema_comparator/result.rb

@@ -1,17 +1,24 @@
 module GraphQL
   module SchemaComparator
+    # The result of a comparison between two schema versions
     class Result
-      attr_reader :changes, :breaking_changes, :non_breaking_changes
+      attr_reader :changes, :breaking_changes, :non_breaking_changes, :dangerous_changes
 
       def initialize(changes)
-        @changes = changes.sort_by { |c| [c.breaking? ? 1 : 2, c.message] }
-        @breaking_changes, @non_breaking_changes = @changes.partition(&:breaking?)
+        @changes = changes.sort_by(&:criticality).reverse
+        @breaking_changes = @changes.select(&:breaking?)
+        @non_breaking_changes = @changes.select(&:non_breaking?)
+        @dangerous_changes = @changes.select(&:dangerous?)
       end
 
+      # If the two schemas were identical
+      # @return [Boolean]
       def identical?
         @changes.empty?
       end
 
+      # If there was a breaking change between the two schema versions
+      # @return [Boolean]
       def breaking?
         breaking_changes.any?
       end

data/lib/graphql/schema_comparator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-schema_comparator
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Marc-Andre Giroux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2017-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -100,6 +100,7 @@ email:
 - mgiroux0@gmail.com
 executables:
 - graphql-schema
+- schema_comparator
 extensions: []
 extra_rdoc_files: []
 files:
@@ -113,10 +114,13 @@ files:
 - Rakefile
 - bin/console
 - bin/graphql-schema
+- bin/schema_comparator
 - bin/setup
 - graphql-schema_comparator.gemspec
 - lib/graphql/schema_comparator.rb
 - lib/graphql/schema_comparator/changes.rb
+- lib/graphql/schema_comparator/changes/criticality.rb
+- lib/graphql/schema_comparator/changes/safe_type_change.rb
 - lib/graphql/schema_comparator/diff/argument.rb
 - lib/graphql/schema_comparator/diff/directive.rb
 - lib/graphql/schema_comparator/diff/directive_argument.rb