nulogy_graphql_api 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b83dfdf7475f2630a23b11b79d071783253eec60759d0b9011c36334413f298
-  data.tar.gz: aef54c3d57c7b7e666758c041682660521e872ee509942d7c5549274836ea57b
+  metadata.gz: f8abde35aa513cd066444a4f67427ce59a53a4e0ecba57f6e404893b7364ff57
+  data.tar.gz: f779d84620bcd6945e9be210bf271aaf55ab33c7952eaea9eb9ed4f34d486857
 SHA512:
-  metadata.gz: 12941fe223139d12da5e571ea7d320d7f55db4cdf53ffe0d0870e60bf1438b01c83c4dc04f91d08ba4aba91dbb617cfa67f873e102d5671a91d8449b0bbe4257
-  data.tar.gz: c339bc9011ce92e493a7e83d4e0a295b10d663b2027933e6530e97be6407fcd2971d75e9b8e849c87671768e30ec07678e892484e0c6ec86f3519039182d8c3f
+  metadata.gz: 6932ab2af2b84d41567627f772a036ff3adb79a57cd8b0d55c897e45f3569c9b843419b49ea09978a307b93d8aa7abcec6dcbcd0ffa9b8e058563713c4fef479
+  data.tar.gz: 1b2588c7c65128f435b4ce474aaf89fe1d6937c90f55efa98758864ab847520867c6624aa26241b6de6728ab443e9b49d4d971fa733da4d432230b73742ba6e2

data/Appraisals

@@ -1,4 +1,5 @@
 appraise "rails-5" do
+  gem "mimemagic", "0.3.10"
   gem "rails", "5.2.4"
 end
 

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## master (unreleased)
 
+## 1.0.0 (2021-05-17)
+
+**Changes**
+
+* **(Breaking)** Change argument to `SchemaGenerator`
+
+The `SchemaGenerator` now takes the path to the `schema.graphql` and the schema class as required arguments.
+See [the update in the README](README.md#Schema-Generation).
+
+## 0.6.0 (2021-02-24)
+
 **Changes**
 
 * **(Potentially Breaking)** Bump graphql gem version to 1.12.5
@@ -18,7 +29,7 @@
 
 **Changes**
 
-* **(Breaking)** Add `context` to the Rake task that generates the schema file.  
+* **(Breaking)** 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)

data/README.md

@@ -9,7 +9,7 @@ Help Nulogy applications be compliant with the [Standard on Error-handling in Gr
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "nulogy_graphql_api", "0.5.3"
+gem "nulogy_graphql_api", "1.0.0"
 ```
 
 And then execute:
@@ -41,9 +41,9 @@ Or install it yourself as:
 
 #### Receiving Requests
 
-Given that you have already defined your GraphQL `Schema` you can receive requests by defining a controller action and execute the params by calling the `NulogyGraphqlApi::GraphqlExecutor`. 
+Given that you have already defined your GraphQL `Schema` you can receive requests by defining a controller action and execute the params by calling the `NulogyGraphqlApi::GraphqlExecutor`.
 
- - Remember to configure your routes to include the controller action. 
+ - Remember to configure your routes to include the controller action.
  - We called the action `execute` in the example below, but you can call it whatever makes more sense for your app.
 
 ```ruby
@@ -53,9 +53,9 @@ module MyApp
 
     def execute
       NulogyGraphqlApi::GraphqlExecutor.execute(
-        params, 
-        context, 
-        Schema, 
+        params,
+        context,
+        Schema,
         NulogyGraphqlApi::TransactionService.new
       )
     end
@@ -74,7 +74,7 @@ module MyApp
 
     def render_error(exception)
       MyApp::ExceptionNotifier.notify(exception)
-        
+
       super
     end
   end
@@ -92,10 +92,10 @@ module MyApp
   class CreateEntity < GraphQL::Schema::Mutation
     field :entity, MyApp::EntityType, null: false
     field :errors, [NulogyGraphqlApi::Types::UserErrorType], null: false
-    
+
     def resolve(args)
       entity = create_entity(args)
-    
+
       {
         entity: entity,
         errors: extract_errors(entity)
@@ -103,7 +103,7 @@ module MyApp
     end
 
     def extract_errors(entity)
-      entity.errors.map do |attribute, message| 
+      entity.errors.map do |attribute, message|
         {
           path: path_for(attribute),
           message: entity.errors.full_message(attribute, message)
@@ -128,7 +128,7 @@ end
 
 ### Schema Generation
 
-There is a Rake task to generate the `schema.graphql` file. You need to provide the `schema_file_path` and the `schema_definition_path` so that the task can detect breaking changes and generate the file. If you don't have a schema file because it's your first time generating it then the rake task will just create one for you in the path provided.
+There is a Rake task to generate the `schema.graphql` file. You need to provide the `schema_file_path` and the schema class so that the task can detect breaking changes and generate the file. If you don't have a schema file because it's your first time generating it then the rake task will just create one for you in the path provided.
 
 There is also a third argument `context`. You'll have to configure it to be able to generate the SDL of fields or types that are only visible for more privileged users.
 
@@ -138,10 +138,10 @@ namespace :graphql_api do
 
   task :generate_schema => :environment do
     schema_file_path = MyApp::Engine.root.join("schema.graphql")
-    schema_definition_path = MyApp::Engine.root.join("path/to/schema/root/schema.rb")
+    schema = MyApp::Namespace::To::Schema
 
     NulogyGraphqlApi::Tasks::SchemaGenerator
-      .new(schema_file_path, schema_definition_path)
+      .new(schema_file_path, schema)
       .generate_schema
   end
 end
@@ -149,7 +149,7 @@ end
 
 ### Node visibility
 
-When you customize the visibility of parts of your graph you have to make sure that all nodes are visible when the schema is being generated by the rake task. You can do so by using the `schema_generation_context?` attribute that is added to the context by the `SchemaGenerator` mentioned in the previous section. 
+When you customize the visibility of parts of your graph you have to make sure that all nodes are visible when the schema is being generated by the rake task. You can do so by using the `schema_generation_context?` attribute that is added to the context by the `SchemaGenerator` mentioned in the previous section.
 
 Here is how to use it:
 
@@ -175,7 +175,7 @@ module MyApp
   class CreateEntity < NulogyGraphqlApi::Schema::BaseMutation
     field :entity, MyApp::EntityType, null: false
     field :errors, [NulogyGraphqlApi::Types::UserErrorType], null: false
-    
+
       def self.visible?(context)
         super { context[:current_user].super_user? }
       end
@@ -202,7 +202,7 @@ RSpec.configure do |config|
   config.include NulogyGraphqlApi::GraphqlMatchers, graphql: true
   config.include NulogyGraphqlApi::GraphqlHelpers, graphql: true
 end
-``` 
+```
 
 #### Test helpers
 
@@ -292,7 +292,7 @@ When you are happy with your changes:
     - Bug Fixes
     - Changes
         - *prepend these with* **(Breaking)***,* **(Potentially Breaking)** *or just leave it blank in case neither applies*
-    
+
 1. Create a Pull Request.
 1. Notify #nulogy-graphql-api Slack channel to get the DRI review and merge your changes.
 

data/gemfiles/rails_5.gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.9"
+gem "mimemagic", "0.3.10"
 gem "rails", "5.2.4"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -6,4 +6,4 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.9"
 gem "rails", "6.0.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/nulogy_graphql_api/tasks/schema_generator.rb

@@ -1,9 +1,9 @@
 module NulogyGraphqlApi
   module Tasks
     class SchemaGenerator
-      def initialize(schema_output_path, schema_definition_path, context: {})
+      def initialize(schema_output_path, schema_definition, context: {})
         @schema_output_path = schema_output_path
-        @schema_definition_path = schema_definition_path
+        @schema_definition = schema_definition
         @context = context.merge(
           schema_generation_context?: true
         )
@@ -19,7 +19,7 @@ module NulogyGraphqlApi
       def check_changes
         return if old_schema.blank?
 
-        SchemaChangesChecker.new.check_changes(old_schema, schema_definition)
+        SchemaChangesChecker.new.check_changes(old_schema, @schema_definition)
       end
 
       def old_schema
@@ -28,11 +28,6 @@ module NulogyGraphqlApi
         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

data/lib/nulogy_graphql_api/version.rb

@@ -1,3 +1,3 @@
 module NulogyGraphqlApi
-  VERSION = "0.6.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nulogy_graphql_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql