nulogy_graphql_api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0610f7398cf9e5bdd286b954237677cffc7252a55eea6b6ab39d074c5f8419eb
-  data.tar.gz: d0eefb1f32964b05d61c53fc7d0195d33d33d34deb2bcb5a0e98d5ab0e040c14
+  metadata.gz: 1db0c5e715fef76694b02bf7886fc6448576ef73aa0e2821dca7e3344843df29
+  data.tar.gz: 4238d07b94c47897ee083813a1845070c5021749d533eae83715c6e5f1e2397a
 SHA512:
-  metadata.gz: 35934eb8f98a759437d27e81bc09b8cd2660e25f5bf4f97efb670e77af5deaba874ef248d3b197480d94ed1a9f07dd5ef5d465da67348fca1526f882859194e3
-  data.tar.gz: 07cde3c7bb90ed41455e215e6e05d648605d4eb978a4b12a7310cad65116a535f5f82b98d1eee67b969591537bad477f2c315abc77421e69cb0f0c4ad4156017
+  metadata.gz: 686d0b9cab9be582ab6b83165c25e629013390024607370d9216e3a1f23324d8d3b28c3603af66ddac4854632b5c8058b14456f1c3becc56173a6c1b8e04fc48
+  data.tar.gz: fcc317f4c19cc3d75f24cf2613d5863c0ef2ac0b8931693ac62941467bc09e245d48bf52b526312d32ac1b2c0ef78fe069f76925757ad83ba6fdd9ced862e2ec

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## master (unreleased)
 
+## 0.5.0
+
+**Breaking Changes**
+
+* Add `context` to the Rake task that generates the schema file.  
+This changes the way the schema is parsed. Please refer to the README file to see an example of how to use `context`.
+
 ## 0.4.0 (2020-07-06)
 
 **Breaking Changes**

data/README.md

@@ -5,7 +5,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "nulogy_graphql_api", "0.4.0", git: "https://github.com/nulogy/nulogy_graphql_api.git"
+gem "nulogy_graphql_api", "0.4.0"
 ```
 
 And then execute:
@@ -126,15 +126,23 @@ end
 There is a Rake task to generate the `schema.graphql` file. All you need to provide is the path to the old and the new schema files so that the task can detect breaking changes. If you don't have an old schema file because it's your first time generating it then the rake task will just create one for you.
 
 ```ruby
-namespace :my_app_graphql_api do
+namespace :graphql_api do
   desc "Generate the graphql schema of the api."
 
   task :generate_schema => :environment do
-    old_schema_file_path = MyApp::Engine.root.join("schema.graphql")
-    new_schema_file_path = MyApp::Engine.root.join("app/graphql/my_app/schema.rb")
-
-    Rake::Task["nulogy_graphql_api:generate_schema"]
-      .invoke(old_schema_file_path, new_schema_file_path)
+    schema_file_path = MyApp::Engine.root.join("schema.graphql")
+    schema_definition_path = MyApp::Engine.root.join("path/to/schema/root/schema.rb")
+
+    # Context is an optional parameter, but may be required if you change the visibility of nodes in your graph 
+    # i.e. 
+    # def visible?(context)
+    #   context[:current_user].superuser?
+    # end
+    context = {}
+
+    NulogyGraphqlApi::Tasks::SchemaGenerator
+      .new(schema_file_path, schema_definition_path, context: context)
+      .generate_schema
   end
 end
 ```

data/lib/nulogy_graphql_api.rb

@@ -4,6 +4,8 @@ require "nulogy_graphql_api/error_handling"
 require "nulogy_graphql_api/graphql_executor"
 require "nulogy_graphql_api/graphql_response"
 require "nulogy_graphql_api/transaction_service"
+require "nulogy_graphql_api/tasks/schema_changes_checker"
+require "nulogy_graphql_api/tasks/schema_generator"
 require "nulogy_graphql_api/types/user_error_type"
 require "nulogy_graphql_api/types/uuid"
 require "nulogy_graphql_api/version"

data/lib/nulogy_graphql_api/tasks/schema_changes_checker.rb

@@ -0,0 +1,32 @@
+require "graphql/schema_comparator"
+require "rainbow"
+
+module NulogyGraphqlApi
+  module Tasks
+    class SchemaChangesChecker
+      def check_changes(old_schema, new_schema)
+        compare_result = GraphQL::SchemaComparator.compare(old_schema, new_schema)
+
+        abort "Task aborted!\n #{Rainbow('No schema changes found.').green}" if compare_result.identical?
+        abort "Task aborted!" unless accept_breaking_changes?(compare_result)
+      end
+
+      private
+
+      def accept_breaking_changes?(compare_result)
+        return true if !compare_result.breaking? && compare_result.dangerous_changes.none?
+
+        puts Rainbow("\nThe current GraphQL Schema has breaking or dangerous changes:").yellow
+
+        compare_result.breaking_changes.concat(compare_result.dangerous_changes).each do |change|
+          puts Rainbow("\n\n- #{change.message} #{change.dangerous? ? '(Dangerous)' : '(Breaking)'}").yellow
+          puts Rainbow("  #{change.criticality.reason}").yellow
+        end
+
+        puts "\n\nDo you want to update the schema anyway? [Y/n]"
+
+        STDIN.gets.chomp.downcase != "n"
+      end
+    end
+  end
+end

data/lib/nulogy_graphql_api/tasks/schema_generator.rb

@@ -0,0 +1,40 @@
+module NulogyGraphqlApi
+  module Tasks
+    class SchemaGenerator
+      def initialize(schema_output_path, schema_definition_path, context: {})
+        @schema_output_path = schema_output_path
+        @schema_definition_path = schema_definition_path
+        @context = context
+      end
+
+      def generate_schema
+        check_changes
+        write_schema_to_file
+      end
+
+      private
+
+      def check_changes
+        return if old_schema.blank?
+
+        SchemaChangesChecker.new.check_changes(old_schema, schema_definition)
+      end
+
+      def old_schema
+        return unless File.exist?(@schema_output_path)
+
+        File.read(@schema_output_path)
+      end
+
+      def schema_definition
+        require @schema_definition_path
+        @schema_definition ||= GraphQL::Schema.descendants.first.to_definition(context: @context)
+      end
+
+      def write_schema_to_file
+        File.write(@schema_output_path, schema_definition)
+        puts Rainbow("\nSuccessfully updated #{@schema_output_path}").green
+      end
+    end
+  end
+end

data/lib/nulogy_graphql_api/version.rb

@@ -1,3 +1,3 @@
 module NulogyGraphqlApi
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/tasks/graphql_schema.rake

@@ -1,75 +1,11 @@
 namespace :nulogy_graphql_api do
   desc "Generate a schema.graphql file"
 
-  class GraphqlSchemaChangesChecker
-    def check_changes(old_schema, new_schema)
-      compare_result = GraphQL::SchemaComparator.compare(old_schema, new_schema)
+  task :generate_schema, [:schema_output_path, :schema_definition_path] => :environment do |_task, args|
+    abort "schema_definition_path is required" unless args.key?(:schema_definition_path)
 
-      abort "Task aborted!\n #{Rainbow('No schema changes found.').green}" if compare_result.identical?
-      abort "Task aborted!" unless accept_breaking_changes?(compare_result)
-    end
-
-    private
-
-    def accept_breaking_changes?(compare_result)
-      return true if !compare_result.breaking? && compare_result.dangerous_changes.none?
-
-      puts Rainbow("\nThe current GraphQL Schema has breaking or dangerous changes:").yellow
-
-      compare_result.breaking_changes.concat(compare_result.dangerous_changes).each do |change|
-        puts Rainbow("\n\n- #{change.message} #{change.dangerous? ? '(Dangerous)' : '(Breaking)'}").yellow
-        puts Rainbow("  #{change.criticality.reason}").yellow
-      end
-
-      puts "\n\nDo you want to update the schema anyway? [Y/n]"
-
-      STDIN.gets.chomp != "n"
-    end
-  end
-
-  class GraphqlSchemaGenerator
-    SCHEMA_FILE_NAME = "schema.graphql"
-
-    def generate_schema(old_schema_file_path, new_schema_file_path)
-      @old_schema_file_path = old_schema_file_path
-      @new_schema_file_path = new_schema_file_path
-
-      generate_schema_file
-    end
-
-    private
-
-    def check_changes(old_schema, new_schema)
-      GraphqlSchemaChangesChecker.new.check_changes(old_schema, new_schema)
-    end
-
-    def new_schema
-      require @new_schema_file_path
-
-      GraphQL::Schema.descendants.first.to_definition
-    end
-
-    def old_schema
-      return nil unless File.exists?(@old_schema_file_path)
-
-      File.read(@old_schema_file_path)
-    end
-
-    def generate_schema_file
-      check_changes(old_schema, new_schema) if old_schema
-
-      write_new_schema_file
-    end
-
-    def write_new_schema_file
-      File.write(@old_schema_file_path, new_schema)
-      puts Rainbow("\nSuccessfully updated #{@old_schema_file_path}").green
-    end
-  end
-
-  task :generate_schema, [:old_schema_file_path, :new_schema_file_path] => :environment do |_task, args|
-    abort "new_schema_file_path is required" unless args.key?(:new_schema_file_path)
-
-    GraphqlSchemaGenerator.new.generate_schema(args[:old_schema_file_path], args[:new_schema_file_path])
+    NulogyGraphqlApi::Tasks::SchemaGenerator
+      .new(args[:schema_output_path], args[:schema_definition_path], context: {})
+      .generate_schema
   end
 end

data/nulogy_graphql_api.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "graphql", "~> 1.9"
   spec.add_dependency "graphql-schema_comparator", "~> 0.6.1"
   spec.add_dependency "rails", ">= 5.2.4", "< 6.1.0"
+  spec.add_dependency "rainbow", "~> 3.0.0"
 
   spec.add_development_dependency "appraisal", "~> 2.1.0"
   spec.add_development_dependency "rspec-rails", "~> 3.9.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nulogy_graphql_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -58,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +189,8 @@ files:
 - lib/nulogy_graphql_api/rspec.rb
 - lib/nulogy_graphql_api/rspec/graphql_helpers.rb
 - lib/nulogy_graphql_api/rspec/graphql_matchers.rb
+- lib/nulogy_graphql_api/tasks/schema_changes_checker.rb
+- lib/nulogy_graphql_api/tasks/schema_generator.rb
 - lib/nulogy_graphql_api/transaction_service.rb
 - lib/nulogy_graphql_api/types/user_error_type.rb
 - lib/nulogy_graphql_api/types/uuid.rb