nulogy_graphql_api 2.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3ef0420e5eced452c468681a47db0bf23f28066a1a8db5b71f264a82a752db3
-  data.tar.gz: 2f6e5aacd8a918f3e5c23502180999e049e434171b20dff3c01187ef14dfa870
+  metadata.gz: 667ac64c08f68824afa3a9295655e83673e5368f7698183ad2ec915511e07ca7
+  data.tar.gz: 47aad12c518ddf7384ec1b72a986d4195e11246780be5f865da50141cd0f6f4b
 SHA512:
-  metadata.gz: eb98d61ac93b589baf8c914c4e8b6cf9021d8a71b69b97474b44566da92b9a9b33a98df877801f9d847658900e63864185d13f69b0eb7454bf59613c83dc6081
-  data.tar.gz: 22827e08ec2ea12acc34048d5bd892b7d95bcdf2a277b93b9a625e87ed9e56a70dab2bb6ca4e5875ad124a951c33088bd8605aac505bfdcff9d7be93e010764b
+  metadata.gz: d9198a3f63dba4a251caa0c271f118d14aa517ad0f76c89f0398459a8c98b513bb994930fd998016d9d980700db8ff3a2e995549b6eda4d7e30648c5c87f84cd
+  data.tar.gz: e55542aad8ed580489783ea890914304e4a98e4f02a7518d6689038977fdeefae3618b927a84486157bb1f057f6680da0c78000394724c97e6c408ed54844615

data/.gitignore

@@ -7,6 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/spec/dummy/tmp/local_secret.txt
+/spec/dummy/db/test.sqlite3*
 
 # rspec failure tracking
 .rspec_status

data/.ruby-version

@@ -1 +1 @@
-2.7.4
+3.1.4

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.4

data/Appraisals

@@ -1,7 +1,3 @@
-appraise "rails-6" do
-  gem "rails", "6.0.3.7"
-end
-
 appraise "rails-6-1" do
   gem "rails", "6.1.4"
 end

data/CHANGELOG.md

@@ -4,6 +4,33 @@
 
 _none_
 
+## 4.0.0 (2024-05-28)
+
+**Changes**
+
+* Remove the `schema_generation_context?` attribute to the GraphQL `context` when generating the schema. Use the
+  already available `GraphQL::Schema::AlwaysVisible` plugin instead.
+  * **(Breaking)** Remove the `NulogyGraphqlApi::Schema::BaseMutation` class which introduced a new API for the 
+    `visible?` method that took a block. This introduced a deviation from the ruby graphql gem's API only for 
+    Mutations and so it was removed. Please ensure that any invocations of `visible?` do not take a block and use
+    `GraphQL::Schema::Mutation` instead.
+  * **(Breaking)** Change the `NulogyGraphqlApi::Tasks::SchemaGenerator#generate_schema` method to output the 
+    stringified version of the schema instead of checking it for changes and writing it to a file.
+  * Expose the `#check_changes` and `#write_schema_to_file` methods on the 
+    `NulogyGraphqlApi::Tasks::SchemaGenerator` to give the user more control over how to build their
+    tooling.
+* Allow the user to be specified for the `request_graphql` test helper.
+
+## 3.0.1 (2024-01-30)
+
+* Add `include_graphql_error` RSpec matcher
+
+## 3.0.0 (2024-01-30)
+
+**Changes**
+* **(Breaking)** Drop support for Rails 6.0
+* **(Breaking)** Drop support for Ruby 2.7
+
 ## 2.2.0 (2024-01-15)
 
 **Changes**

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", "2.1.0"
+gem "nulogy_graphql_api", "3.0.1"
 ```
 
 And then execute:
@@ -130,8 +130,6 @@ end
 
 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.
-
 ```ruby
 namespace :graphql_api do
   desc "Generate the graphql schema of the api."
@@ -142,47 +140,7 @@ namespace :graphql_api do
 
     NulogyGraphqlApi::Tasks::SchemaGenerator
       .new(schema_file_path, schema)
-      .generate_schema
-  end
-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.
-
-Here is how to use it:
-
-##### On fields
-```ruby
-field :entity, MyApp::EntityType, null: false do
-  description "Find an entity by ID"
-  argument :id, ID, required: true
-
-  def visible?(context)
-    context[:schema_generation_context?] || context[:current_user].superuser?
-  end
-end
-```
-
-
-##### On mutations
-
-In this case the `schema_generation_context?` attribute is checked by the `BaseMutation` class. All you have to do is inheriting from it and override `visible?` passing a block to the base method.
-
-```ruby
-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
-
-    def resolve(args)
-      # ...
-    end
+      .write_schema_to_file
   end
 end
 ```
@@ -237,7 +195,7 @@ The `request_graphql` helper issues a POST request against the provided URL. Thi
 ```ruby
 RSpec.describe MyApp::Graphql::Query, :graphql, type: :request do
   it "returns 401 Unauthorized given an unauthenticated request" do
-      gql_response = request_graphql(url, <<~GRAPHQL, headers: { "HTTP_AUTHORIZATION" => nil })
+      gql_response = request_graphql(url, <<~GRAPHQL, headers: { "HTTP_AUTHORIZATION" => nil }, user: default_user)
         query {
           entities {
             id
@@ -253,9 +211,7 @@ end
 
 #### Custom matchers
 
-These are the custom matchers available:
-
-`have_graphql_data` for checking the response `data`
+Use `have_graphql_data` for checking the response `data`.
 
 ```ruby
 expect(response).to have_graphql_data(
@@ -265,12 +221,20 @@ expect(response).to have_graphql_data(
 )
 ```
 
-`have_graphql_error` for checking the response `errors`
+Use `have_graphql_error` for matching exactly on the response `errors`. <br/>
+The match succeeds when the `errors` array contains a single entry with the specified message.
 
 ```ruby
 expect(response).to have_graphql_error("Error message")
 ```
 
+Use `include_graphql_error` for matching inclusively on the response `errors`. <br/>
+The match succeeds when the `errors` array includes an entry with the specified message.
+
+```ruby
+expect(response).to include_graphql_error("Error message")
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/nulogy_graphql_api/rspec/graphql_helpers.rb

@@ -1,5 +1,7 @@
 module NulogyGraphqlApi
   module GraphqlHelpers
+    # Prefer the `request_graphql` method over this one because it exercises more of the stack but doesn't run
+    # much slower.
     def execute_graphql(query, schema, variables: {}, context: {})
       camelized_variables = variables.deep_transform_keys! { |key| key.to_s.camelize(:lower) } || {}
 
@@ -13,11 +15,11 @@ module NulogyGraphqlApi
       response.to_h.deep_symbolize_keys
     end
 
-    def request_graphql(url, query, variables: {}, headers: {})
+    def request_graphql(url, query, variables: {}, headers: {}, user: nil)
       params = { query: query, variables: variables }.to_json
       default_headers = {
         CONTENT_TYPE: "application/json",
-        HTTP_AUTHORIZATION: basic_auth_token(default_user.login)
+        HTTP_AUTHORIZATION: basic_auth_token((user || default_user).login)
       }
 
       post url, params: params, headers: default_headers.merge(headers)

data/lib/nulogy_graphql_api/rspec/graphql_matchers.rb

@@ -34,5 +34,13 @@ module NulogyGraphqlApi
         })
       end
     end
+
+    RSpec::Matchers.define :include_graphql_error do |message|
+      match do |actual_response|
+        expect(actual_response.fetch(:errors, nil)).to include(a_hash_including(
+          message: include(message)
+        ))
+      end
+    end
   end
 end

data/lib/nulogy_graphql_api/tasks/schema_generator.rb

@@ -4,37 +4,32 @@ module NulogyGraphqlApi
       def initialize(schema_output_path, schema, context: {})
         @schema_output_path = schema_output_path
         @schema = schema
-        @context = context.merge(
-          schema_generation_context?: true
-        )
+        @context = context
       end
 
       def generate_schema
-        check_changes
-        write_schema_to_file
+        visible_schema = Class.new(@schema)
+        visible_schema.use(GraphQL::Schema::AlwaysVisible)
+        visible_schema.to_definition(context: @context)
       end
 
-      private
-
       def check_changes
         return if old_schema.blank?
 
-        SchemaChangesChecker.new.check_changes(old_schema, @schema)
-      end
-
-      def old_schema
-        return unless File.exist?(@schema_output_path)
-
-        File.read(@schema_output_path)
+        SchemaChangesChecker.new.check_changes(old_schema, generate_schema)
       end
 
       def write_schema_to_file
-        File.write(@schema_output_path, schema_definition)
+        File.write(@schema_output_path, generate_schema)
         puts Rainbow("\nSuccessfully updated #{@schema_output_path}").green
       end
 
-      def schema_definition
-        GraphQL::Schema::Printer.print_schema(@schema, context: @context)
+      private
+
+      def old_schema
+        return unless File.exist?(@schema_output_path)
+
+        File.read(@schema_output_path)
       end
     end
   end

data/lib/nulogy_graphql_api/version.rb

@@ -1,3 +1,3 @@
 module NulogyGraphqlApi
-  VERSION = "2.2.0"
+  VERSION = "4.0.0"
 end

data/lib/nulogy_graphql_api.rb

@@ -3,7 +3,6 @@ require "graphql"
 require "nulogy_graphql_api/error_handling"
 require "nulogy_graphql_api/graphql_executor"
 require "nulogy_graphql_api/graphql_response"
-require "nulogy_graphql_api/schema/base_mutation"
 require "nulogy_graphql_api/transaction_service"
 require "nulogy_graphql_api/tasks/schema_changes_checker"
 require "nulogy_graphql_api/tasks/schema_generator"

data/nulogy_graphql_api.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
     "rubygems_mfa_required" => "true"
   }
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "graphql", "~> 2"
   spec.add_dependency "graphql-schema_comparator", "~> 1.2"
-  spec.add_dependency "rails", ">= 6.0", "< 8.0"
+  spec.add_dependency "rails", ">= 6.1", "< 8.0"
   spec.add_dependency "rainbow", "~> 3.0"
 
   spec.add_development_dependency "appraisal", "~> 2.5"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nulogy_graphql_api
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Daniel Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql
@@ -44,7 +44,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -54,7 +54,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -213,6 +213,7 @@ files:
 - ".rubocop.directories.yml"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".tool-versions"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -222,7 +223,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/rails_6.gemfile
 - gemfiles/rails_6_1.gemfile
 - gemfiles/rails_7.gemfile
 - lib/nulogy_graphql_api.rb
@@ -234,7 +234,6 @@ 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/schema/base_mutation.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
@@ -260,14 +259,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Standard tooling for building GraphQL apis

data/gemfiles/rails_6.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "6.0.3.7"
-
-gemspec path: "../"

data/lib/nulogy_graphql_api/schema/base_mutation.rb

@@ -1,12 +0,0 @@
-module NulogyGraphqlApi
-  module Schema
-    class BaseMutation < GraphQL::Schema::Mutation
-      def self.visible?(context)
-        return true if context[:schema_generation_context?]
-        return super && yield if block_given?
-
-        super
-      end
-    end
-  end
-end