hq-graphql 0.0.2 → 1.0.0

data/spec/lib/graphql/resource_spec.rb

@@ -0,0 +1,374 @@
+require 'rails_helper'
+
+describe ::HQ::GraphQL::Resource do
+  let(:organization_type) do
+    Class.new do
+      include ::HQ::GraphQL::Resource
+      self.model_name = "Organization"
+    end
+  end
+
+  let(:advisor_type) do
+    Class.new do
+      include ::HQ::GraphQL::Resource
+      self.model_name = "Advisor"
+
+      root_query
+    end
+  end
+
+  let(:root_query) do
+    Class.new(::HQ::GraphQL::RootQuery)
+  end
+
+  let(:root_mutation) do
+    Class.new(::HQ::GraphQL::RootMutation)
+  end
+
+  let(:schema) do
+    Class.new(GraphQL::Schema) do
+      query(RootQuery)
+      mutation(RootMutation)
+    end
+  end
+
+  before(:each) do
+    advisor_type
+    stub_const("RootQuery", root_query)
+    stub_const("RootMutation", root_mutation)
+  end
+
+  context "defaults" do
+    it "builds the query klass" do
+      expect(::HQ::GraphQL::Types[Advisor]).to eql(advisor_type.query_klass)
+    end
+
+    it "builds the input klass" do
+      expect(::HQ::GraphQL::Inputs[Advisor]).to eql(advisor_type.input_klass)
+    end
+
+    it "creates query fields" do
+      ::HQ::GraphQL::Types[Advisor].graphql_definition
+      expected = ["id", "organizationId", "name", "createdAt", "updatedAt"]
+      expect(::HQ::GraphQL::Types[Advisor].fields.keys).to contain_exactly(*expected)
+    end
+
+    it "creates query graphql name" do
+      ::HQ::GraphQL::Types[Advisor].graphql_definition
+      expect(::HQ::GraphQL::Types[Advisor].graphql_name).to eql("Advisor")
+    end
+
+    it "creates input arguments" do
+      ::HQ::GraphQL::Inputs[Advisor].graphql_definition
+      expected = ["id", "organizationId", "name", "createdAt", "updatedAt"]
+      expect(::HQ::GraphQL::Inputs[Advisor].arguments.keys).to contain_exactly(*expected)
+    end
+
+    it "creates input graphql name" do
+      ::HQ::GraphQL::Inputs[Advisor].graphql_definition
+      expect(::HQ::GraphQL::Inputs[Advisor].graphql_name).to eql("AdvisorInput")
+    end
+
+    it "doesn't create mutations" do
+      expect(advisor_type.mutation_klasses).to be_empty
+    end
+
+    context "with an association" do
+      before(:each) do
+        organization_type
+      end
+
+      it "adds organization type" do
+        ::HQ::GraphQL::Types[Advisor].graphql_definition
+        expected = ["id", "organization", "organizationId", "name", "createdAt", "updatedAt"]
+        expect(::HQ::GraphQL::Types[Advisor].fields.keys).to contain_exactly(*expected)
+      end
+
+      it "doesn't add organization type" do
+        ::HQ::GraphQL::Inputs[Advisor].graphql_definition
+        expected = ["id", "organizationId", "name", "createdAt", "updatedAt"]
+        expect(::HQ::GraphQL::Inputs[Advisor].arguments.keys).to contain_exactly(*expected)
+      end
+    end
+  end
+
+  context ".query" do
+    let(:advisor_type) do
+      Class.new do
+        include ::HQ::GraphQL::Resource
+        self.model_name = "Advisor"
+
+        query associations: false do
+          graphql_name "CustomAdvisorName"
+          remove_attr :name
+        end
+      end
+    end
+
+    before(:each) do
+      organization_type
+      advisor_type
+    end
+
+    it "removes name" do
+      ::HQ::GraphQL::Types[Advisor].graphql_definition
+      expected = ["id", "organizationId", "createdAt", "updatedAt"]
+      expect(::HQ::GraphQL::Types[Advisor].fields.keys).to contain_exactly(*expected)
+    end
+
+    it "customizes graphql name" do
+      ::HQ::GraphQL::Types[Advisor].graphql_definition
+      expect(::HQ::GraphQL::Types[Advisor].graphql_name).to eql("CustomAdvisorName")
+    end
+  end
+
+  context ".input" do
+    let(:advisor_type) do
+      Class.new do
+        include ::HQ::GraphQL::Resource
+        self.model_name = "Advisor"
+
+        input do
+          graphql_name "CustomAdvisorInput"
+          remove_attr :name
+        end
+      end
+    end
+
+    before(:each) do
+      organization_type
+      advisor_type
+    end
+
+    it "removes name" do
+      ::HQ::GraphQL::Inputs[Advisor].graphql_definition
+      expected = ["id", "organizationId", "createdAt", "updatedAt"]
+      expect(::HQ::GraphQL::Inputs[Advisor].arguments.keys).to contain_exactly(*expected)
+    end
+
+    it "customizes graphql name" do
+      ::HQ::GraphQL::Inputs[Advisor].graphql_definition
+      expect(::HQ::GraphQL::Inputs[Advisor].graphql_name).to eql("CustomAdvisorInput")
+    end
+  end
+
+  context ".mutations" do
+    let(:advisor_type) do
+      Class.new do
+        include ::HQ::GraphQL::Resource
+        self.model_name = "Advisor"
+
+        mutations
+
+        input do
+          remove_attr :name
+          add_association :organization
+        end
+      end
+    end
+
+    before(:each) do
+      organization_type
+    end
+
+    it "generates the create, update, and destroy mutations by default" do
+      expect(advisor_type.mutation_klasses.keys).to contain_exactly("create_advisor", "update_advisor", "destroy_advisor")
+    end
+
+    it "removes name on update" do
+      update_mutation = advisor_type.mutation_klasses[:update_advisor]
+      update_mutation.payload_type
+
+      aggregate_failures do
+        expected_arguments = ["id", "organizationId", "organizationAttributes", "createdAt", "updatedAt"]
+        expect(update_mutation.arguments.keys).to contain_exactly(*expected_arguments)
+
+        expected_fields = ["errors", "resource"]
+        expect(update_mutation.fields.keys).to contain_exactly(*expected_fields)
+      end
+    end
+  end
+
+  context "execution" do
+    let(:find_advisor) {
+      <<-gql
+        query findAdvisor($id: UUID!){
+          advisor(id: $id) {
+            name
+            organizationId
+
+            organization {
+              name
+            }
+          }
+        }
+      gql
+    }
+
+    let(:create_mutation) {
+      <<-gql
+        mutation createAdvisor($name: String!, $organizationId: UUID!){
+          createAdvisor(name: $name, organizationId: $organizationId) {
+            errors
+            resource {
+              id
+              name
+            }
+          }
+        }
+      gql
+    }
+
+    let(:update_mutation) {
+      <<-gql
+        mutation updateAdvisor($id: UUID!, $name: String!, $organizationAttributes: OrganizationInput){
+          updateAdvisor(id: $id, name: $name, organizationAttributes: $organizationAttributes) {
+            errors
+            resource {
+              name
+              organization {
+                name
+              }
+            }
+          }
+        }
+      gql
+    }
+
+    let(:destroy_mutation) {
+      <<-gql
+        mutation destroyAdvisor($id: UUID!){
+          destroyAdvisor(id: $id) {
+            errors
+            resource {
+              name
+            }
+          }
+        }
+      gql
+    }
+
+    before(:each) do
+      organization_type
+
+      advisor_type.class_eval do
+        mutations
+
+        input do
+          add_association :organization
+        end
+      end
+    end
+
+    it "fetches results" do
+      advisor = FactoryBot.create(:advisor)
+      results = schema.execute(find_advisor, variables: { id: advisor.id })
+      data = results["data"]["advisor"]
+
+      aggregate_failures do
+        expect(data["name"]).to eql(advisor.name)
+        expect(data["organizationId"]).to eql(advisor.organization_id)
+        expect(data["organization"]["name"]).to eql(advisor.organization.name)
+      end
+    end
+
+    it "creates" do
+      organization = FactoryBot.create(:organization)
+      name = "Bob"
+      results = schema.execute(create_mutation, variables: { name: name, organizationId: organization.id })
+
+      data = results["data"]
+      aggregate_failures do
+        expect(data["errors"]).to be_nil
+        expect(data["createAdvisor"]["resource"]["name"]).to eql name
+        expect(Advisor.where(id: data["createAdvisor"]["resource"]["id"]).exists?).to eql true
+      end
+    end
+
+    it "updates" do
+      advisor = FactoryBot.create(:advisor)
+      name = "Bob"
+      organization_name = "Foo"
+
+      results = schema.execute(update_mutation, variables: {
+        id: advisor.id,
+        name: name,
+        organizationAttributes: { id: advisor.organization_id, name: organization_name }
+      })
+
+      data = results["data"]
+      aggregate_failures do
+        expect(data["errors"]).to be_nil
+        expect(data["updateAdvisor"]["resource"]["name"]).to eql name
+        expect(data["updateAdvisor"]["resource"]["organization"]["name"]).to eql organization_name
+        expect(Advisor.find(advisor.id).name).to eql name
+        expect(Organization.find(advisor.organization_id).name).to eql organization_name
+      end
+    end
+
+    it "destroys" do
+      advisor = FactoryBot.create(:advisor)
+      results = schema.execute(destroy_mutation, variables: { id: advisor.id })
+
+      data = results["data"]
+      aggregate_failures do
+        expect(data["errors"]).to be_nil
+        expect(data["destroyAdvisor"]["resource"]["name"]).to eql advisor.name
+        expect(Advisor.where(id: advisor.id).exists?).to eql false
+      end
+    end
+
+    context "with a global scope" do
+      before(:each) do
+        allow(::HQ::GraphQL).to receive(:default_scope) { Advisor.none }
+      end
+
+      it "returns nothing" do
+        advisor = FactoryBot.create(:advisor)
+        results = schema.execute(find_advisor, variables: { id: advisor.id })
+
+        expect(results["data"]["advisor"]).to be_nil
+      end
+
+      it "returns an error on a mutation" do
+        advisor = FactoryBot.create(:advisor)
+        results = schema.execute(update_mutation, variables: { id: advisor.id, name: "Bob" })
+
+        data = results["data"]
+        aggregate_failures do
+          expect(data["updateAdvisor"]["errors"]).to be_present
+          expect(data["updateAdvisor"]["resource"]).to be_nil
+        end
+      end
+    end
+
+    context "with a local scope" do
+      before(:each) do
+        advisor_type.class_eval do
+          default_scope do
+            Advisor.none
+          end
+        end
+      end
+
+      it "returns nothing" do
+        advisor = FactoryBot.create(:advisor)
+        results = schema.execute(find_advisor, variables: { id: advisor.id })
+
+        expect(results["data"]["advisor"]).to be_nil
+      end
+
+      it "returns an error on a mutation" do
+        advisor = FactoryBot.create(:advisor)
+        results = schema.execute(update_mutation, variables: { id: advisor.id, name: "Bob" })
+
+        data = results["data"]
+        aggregate_failures do
+          expect(data["updateAdvisor"]["errors"]).to be_present
+          expect(data["updateAdvisor"]["resource"]).to be_nil
+        end
+      end
+    end
+  end
+
+end

data/spec/lib/graphql/types/uuid_spec.rb

@@ -0,0 +1,65 @@
+require 'rails_helper'
+
+describe ::HQ::GraphQL::Types::UUID do
+  let(:hql_object_klass) do
+    Class.new(::HQ::GraphQL::Object) do
+      graphql_name "TestQuery"
+
+      field :name, ::HQ::GraphQL::Types::UUID, null: false
+    end
+  end
+
+  let(:query) do
+    Class.new(::HQ::GraphQL::Object) do
+      graphql_name "Query"
+
+      field :advisor, AdvisorType, null: false do
+        argument :id, ::HQ::GraphQL::Types::UUID, required: true
+      end
+
+      def advisor(id:)
+        Advisor.find(id)
+      end
+    end
+  end
+
+  let(:schema) do
+    Class.new(GraphQL::Schema) do
+      query(Query)
+    end
+  end
+
+  let(:query_str) do
+    <<-gql
+      query findAdvisor($id: UUID!){
+        advisor(id: $id) {
+          name
+        }
+      }
+    gql
+  end
+
+  before(:each) do
+    stub_const("AdvisorType", hql_object_klass)
+    stub_const("Query", query)
+  end
+
+  describe ".coerce_result" do
+    it "raises an error on incorrect type" do
+      advisor = FactoryBot.create(:advisor)
+      expect { schema.execute(query_str, variables: { id: advisor.id }) }.to raise_error(
+        ::GraphQL::CoercionError, "\"#{advisor.name}\" is not a valid UUID"
+      )
+    end
+  end
+
+  describe ".coerce_input" do
+    it "displays an error message" do
+      result = schema.execute(query_str, variables: { id: "1" })
+      aggregate_failures do
+        expect(result["errors"].length).to eql(1)
+        expect(result["errors"][0]["message"]).to eql("Variable id of type UUID! was provided invalid value")
+      end
+    end
+  end
+end

data/spec/lib/graphql/types_spec.rb

@@ -0,0 +1,40 @@
+require 'rails_helper'
+
+describe ::HQ::GraphQL::Types do
+
+  describe ".[]" do
+    let(:graphql_klass) do
+      Class.new do
+        include ::HQ::GraphQL::Resource
+
+        self.model_name = "Advisor"
+
+        query(attributes: false, associations: false) do
+          field :custom_field, String, null: false
+        end
+      end
+    end
+
+    it "finds the type" do
+      type_object = graphql_klass.query_klass
+
+      aggregate_failures do
+        expect(type_object.superclass).to eql(::HQ::GraphQL::Object)
+        expect(type_object).to eql(described_class[Advisor])
+        expect(type_object.fields.keys).to contain_exactly("customField")
+        type_object.to_graphql
+        expect(type_object.fields.keys).to contain_exactly("customField")
+      end
+    end
+
+    it "finds the type when lookup is a string" do
+      type_object = graphql_klass.query_klass
+      expect(type_object).to eql(described_class["Advisor"])
+    end
+
+    it "raises an exception for unknown types" do
+      expect { described_class[Advisor] }.to raise_error(described_class::Error)
+    end
+  end
+
+end

data/spec/rails_helper.rb

@@ -32,10 +32,12 @@ RSpec.configure do |config|
   end
 
   config.before(:each) do
+    ::HQ::GraphQL.reset!
     DatabaseCleaner.start
   end
 
   config.after(:each) do
     DatabaseCleaner.clean
+    ::HQ::GraphQL.reset!
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hq-graphql
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Danny Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -33,7 +33,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: 1.8.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.7
+        version: 1.8.10
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -96,25 +96,37 @@ files:
 - Rakefile
 - lib/hq-graphql.rb
 - lib/hq/graphql.rb
+- lib/hq/graphql/active_record_extensions.rb
 - lib/hq/graphql/engine.rb
+- lib/hq/graphql/input_extensions.rb
+- lib/hq/graphql/input_object.rb
+- lib/hq/graphql/inputs.rb
+- lib/hq/graphql/mutation.rb
 - lib/hq/graphql/object.rb
+- lib/hq/graphql/resource.rb
+- lib/hq/graphql/resource/mutation.rb
+- lib/hq/graphql/root_mutation.rb
+- lib/hq/graphql/root_query.rb
+- lib/hq/graphql/scalars.rb
 - lib/hq/graphql/types.rb
 - lib/hq/graphql/types/uuid.rb
 - lib/hq/graphql/version.rb
 - spec/factories/advisors.rb
 - spec/factories/organizations.rb
 - spec/factories/users.rb
-- spec/internal/app/graphql/query.rb
-- spec/internal/app/graphql/schema.rb
-- spec/internal/app/graphql/user_type.rb
 - spec/internal/app/models/advisor.rb
 - spec/internal/app/models/organization.rb
 - spec/internal/app/models/user.rb
 - spec/internal/config/database.circleci.yml
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
-- spec/lib/object_spec.rb
-- spec/lib/types_spec.rb
+- spec/lib/graphql/active_record_extensions_spec.rb
+- spec/lib/graphql/inputs_spec.rb
+- spec/lib/graphql/mutation_spec.rb
+- spec/lib/graphql/object_spec.rb
+- spec/lib/graphql/resource_spec.rb
+- spec/lib/graphql/types/uuid_spec.rb
+- spec/lib/graphql/types_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 homepage: https://github.com/OneHQ/hq-graphql
@@ -146,15 +158,17 @@ test_files:
 - spec/internal/app/models/advisor.rb
 - spec/internal/app/models/organization.rb
 - spec/internal/app/models/user.rb
-- spec/internal/app/graphql/schema.rb
-- spec/internal/app/graphql/query.rb
-- spec/internal/app/graphql/user_type.rb
 - spec/internal/config/database.circleci.yml
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
 - spec/factories/organizations.rb
 - spec/factories/advisors.rb
 - spec/factories/users.rb
-- spec/lib/object_spec.rb
-- spec/lib/types_spec.rb
+- spec/lib/graphql/types/uuid_spec.rb
+- spec/lib/graphql/active_record_extensions_spec.rb
+- spec/lib/graphql/object_spec.rb
+- spec/lib/graphql/inputs_spec.rb
+- spec/lib/graphql/resource_spec.rb
+- spec/lib/graphql/types_spec.rb
+- spec/lib/graphql/mutation_spec.rb
 - spec/rails_helper.rb

data/spec/internal/app/graphql/query.rb

@@ -1,18 +0,0 @@
-class Query < GraphQL::Schema::Object
-  graphql_name "Query"
-
-  field :users, [HQ::GraphQL::Types[User]], null: false
-  field :advisors, [HQ::GraphQL::Types[Advisor]], null: false
-
-  def users
-    User.all
-  end
-
-  def users_custom
-    users
-  end
-
-  def advisors
-    Advisor.all
-  end
-end

data/spec/internal/app/graphql/schema.rb

@@ -1,3 +0,0 @@
-class Schema < GraphQL::Schema
-  query(Query)
-end

data/spec/internal/app/graphql/user_type.rb

@@ -1,3 +0,0 @@
-class UserType < HQ::GraphQL::Object
-  with_model "User"
-end