hq-graphql 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b25a73fce273a48a00a185766cae51a9ec2e3150
-  data.tar.gz: 7c325eaef387c340778954fb83dbb3d0ccac9c03
+  metadata.gz: ab6e40470755691d1fe10f268c3652f19ad894ec
+  data.tar.gz: fb75a2bfa83aed220ef40b5461429923dd5f56f5
 SHA512:
-  metadata.gz: da27072503a7751c1eefa68ebdf6a0fcb77b28a6213fb8fb6a4d7fdec32d9f0bd14dfb585d0196f4d1119cd2d5ecb8d33e54c7c1e902051612e3fb7d9e2ab815
-  data.tar.gz: c5b52d4d4d8af7fe53b1c1aa50ad28b62eb36b66c2f39de2e6b4a51add6505c110b3e7d6182f0efcb302d53ca70c78ccf1d5817206eef413635d033832cc10af
+  metadata.gz: cce3a3348a0cee0faf0c4edd5055296cdd4907aadfb953e36615bca342e203fcf70a05f83a84754cc05fef1c3756d94e2c3e97addce552adbc535c733f1035e2
+  data.tar.gz: 9641b93d8845695db06a950b9236f0566df6371ba5c1c960ddd4ec6422cb60ecd369be6b3678595529bbeae1495402a69868e9107b5f7591055d9e226eec4a63

data/lib/hq/graphql/active_record_extensions.rb

@@ -38,7 +38,7 @@ module HQ
           # validate removed_attributes exist
           removed_attributes.each { |attr| column_from_model(attr) }
 
-          model_columns.reject { |c| removed_attributes.include?(c.name.to_sym) }
+          model_columns.reject { |c| removed_attributes.include?(c.name.to_sym) }.sort_by(&:name)
         end
 
         def model_associations
@@ -52,7 +52,7 @@ module HQ
           # validate removed_associations exist
           removed_associations.each { |association| association_from_model(association) }
 
-          model_associations.reject { |a| removed_associations.include?(a.name.to_sym) }
+          model_associations.reject { |a| removed_associations.include?(a.name.to_sym) }.sort_by(&:name)
         end
 
         private

data/lib/hq/graphql/input_object.rb

@@ -1,15 +1,78 @@
 module HQ
   module GraphQL
     class InputObject < ::GraphQL::Schema::InputObject
-      include ::HQ::GraphQL::InputExtensions
+      include Scalars
+      include ::HQ::GraphQL::ActiveRecordExtensions
+
+      # Recursively format attributes so that they are compatible with `accepts_nested_attributes_for`
+      def format_nested_attributes
+        self.each.inject({}) do |formatted_attrs, (key, value) |
+          if self.class.nested_attributes.include?(key.to_s)
+            formatted_attrs["#{key}_attributes"] = value.format_nested_attributes
+          else
+            formatted_attrs[key] = value
+          end
+          formatted_attrs
+        end
+      end
+
+      def with_indifferent_access
+        to_h.with_indifferent_access
+      end
+
+      #### Class Methods ####
+
+      def self.with_model(model_name, attributes: true, associations: false)
+        self.model_name = model_name
+        self.auto_load_attributes = attributes
+        self.auto_load_associations = associations
+
+        lazy_load do
+          model_columns.each do |column|
+            argument_from_column(column)
+          end
+
+          model_associations.each do |association|
+            argument_from_association association
+          end
+        end
+      end
+
+      def self.nested_attributes
+        @nested_attributes ||= Set.new
+      end
 
       def self.to_graphql
         lazy_load!
         super
       end
 
-      def with_indifferent_access
-        to_h.with_indifferent_access
+      class << self
+        private
+
+        def argument_from_association(association)
+          input = ::HQ::GraphQL::Inputs[association.klass]
+          name = association.name
+
+          case association.macro
+          when :has_many
+            argument name, [input], required: false
+          else
+            argument name, input, required: false
+          end
+
+          if !model_klass.nested_attributes_options.keys.include?(name.to_sym)
+            model_klass.accepts_nested_attributes_for name, allow_destroy: true
+          end
+
+          nested_attributes << name.to_s
+        rescue ::HQ::GraphQL::Inputs::Error
+          nil
+        end
+
+        def argument_from_column(column)
+          argument column.name, ::HQ::GraphQL::Types.type_from_column(column), required: false
+        end
       end
 
     end

data/lib/hq/graphql/mutation.rb

@@ -1,7 +1,8 @@
 module HQ
   module GraphQL
     class Mutation < ::GraphQL::Schema::Mutation
-      include ::HQ::GraphQL::InputExtensions
+      include Scalars
+      include ::HQ::GraphQL::ActiveRecordExtensions
 
       def self.generate_payload_type
         lazy_load!

data/lib/hq/graphql/resource/mutation.rb

@@ -8,7 +8,7 @@ module HQ
             graphql_name graphql_name
 
             lazy_load do
-              field :errors, [String], null: false
+              field :errors, ::HQ::GraphQL::Types::JSON, null: false
               field :resource, ::HQ::GraphQL::Types[model_name], null: true
             end
 
@@ -23,6 +23,10 @@ module HQ
                 argument primary_key, ::HQ::GraphQL::Types.type_from_column(pk_column), required: true
               end
             end
+
+            def errors_from_resource(resource)
+              resource.errors.to_h.deep_transform_keys { |k| k.to_s.camelize(:lower) }
+            end
           end
         end
 

data/lib/hq/graphql/resource.rb

@@ -6,7 +6,8 @@ module HQ
 
       def self.included(base)
         ::HQ::GraphQL.types << base
-        base.extend(ClassMethods)
+        base.include Scalars
+        base.extend ClassMethods
       end
 
       module ClassMethods
@@ -27,14 +28,7 @@ module HQ
         end
 
         def input_klass
-          @input_klass ||= begin
-            scoped_model_name = model_name
-            scoped_inputs_proc = inputs_proc
-            Class.new(::HQ::GraphQL::InputObject) do
-              graphql_name "#{scoped_model_name.demodulize}Input"
-              instance_eval(&scoped_inputs_proc)
-            end
-          end
+          @input_klass ||= build_input_object
         end
 
         def query_klass
@@ -43,43 +37,39 @@ module HQ
 
         protected
 
-        def inputs_proc
-          @inputs_proc ||= build_input_proc
-        end
-
         def default_scope(&block)
           @default_scope = block
         end
 
         def input(**options, &block)
-          @inputs_proc = build_input_proc(**options, &block)
+          @input_klass = build_input_object(**options, &block)
         end
 
         def mutations(create: true, update: true, destroy: true)
+          scoped_model_name = model_name
           model_display_name = model_name.demodulize
           scoped_self = self
-          delayed_execute_inputs_proc = proc { scoped_self.inputs_proc }
 
           if create
             create_mutation = ::HQ::GraphQL::Resource::Mutation.build(model_name, graphql_name: "#{model_display_name}Create") do
-              define_method(:resolve) do |**attrs|
+              define_method(:resolve) do |**args|
                 resource = scoped_self.model_klass.new
-                resource.assign_attributes(attrs)
+                resource.assign_attributes(args[:attributes].format_nested_attributes)
                 if resource.save
                   {
                     resource: resource,
-                    errors: [],
+                    errors: {},
                   }
                 else
                   {
                     resource: nil,
-                    errors: resource.errors.full_messages
+                    errors: errors_from_resource(resource)
                   }
                 end
               end
 
               lazy_load do
-                instance_eval(&delayed_execute_inputs_proc.call)
+                argument :attributes, ::HQ::GraphQL::Inputs[scoped_model_name], required: true
               end
             end
 
@@ -92,32 +82,32 @@ module HQ
               graphql_name: "#{model_display_name}Update",
               require_primary_key: true
             ) do
-              define_method(:resolve) do |**attrs|
-                resource = scoped_self.find_record(attrs, context)
+              define_method(:resolve) do |**args|
+                resource = scoped_self.find_record(args, context)
 
                 if resource
-                  resource.assign_attributes(attrs)
+                  resource.assign_attributes(args[:attributes].format_nested_attributes)
                   if resource.save
                     {
                       resource: resource,
-                      errors: [],
+                      errors: {},
                     }
                   else
                     {
                       resource: resource,
-                      errors: resource.errors.full_messages
+                      errors: errors_from_resource(resource)
                     }
                   end
                 else
                   {
                     resource: nil,
-                    errors: ["Unable to find #{model_display_name}"],
+                    errors: { resource: "Unable to find #{model_display_name}" }
                   }
                 end
               end
 
               lazy_load do
-                instance_eval(&delayed_execute_inputs_proc.call)
+                argument :attributes, ::HQ::GraphQL::Inputs[scoped_model_name], required: true
               end
             end
 
@@ -142,13 +132,13 @@ module HQ
                   else
                     {
                       resource: resource,
-                      errors: resource.errors.full_messages
+                      errors: errors_from_resource(resource)
                     }
                   end
                 else
                   {
                     resource: nil,
-                    errors: ["Unable to find #{model_display_name}"],
+                    errors: { resource: "Unable to find #{model_display_name}" }
                   }
                 end
               end
@@ -181,15 +171,18 @@ module HQ
 
             with_model scoped_model_name, **options
 
-            instance_eval(&block) if block
+            class_eval(&block) if block
           end
         end
 
-        def build_input_proc(**options, &block)
+        def build_input_object(**options, &block)
           scoped_model_name = model_name
-          proc do
+          Class.new(::HQ::GraphQL::InputObject) do
+            graphql_name "#{scoped_model_name.demodulize}Input"
+
             with_model scoped_model_name, **options
-            instance_eval(&block) if block
+
+            class_eval(&block) if block
           end
         end
 

data/lib/hq/graphql/scalars.rb

@@ -1,8 +1,10 @@
+require "hq/graphql/types/json"
 require "hq/graphql/types/uuid"
 
 module HQ
   module GraphQL
     module Scalars
+      JSON = ::HQ::GraphQL::Types::JSON
       UUID = ::HQ::GraphQL::Types::UUID
     end
   end

data/lib/hq/graphql/types/json.rb

@@ -0,0 +1,20 @@
+module HQ
+  module GraphQL
+    module Types
+      class JSON < ::GraphQL::Schema::Scalar
+        description "JSON"
+
+        class << self
+          def coerce_input(value, context)
+            JSON.parse(value)
+          end
+
+          def coerce_result(value, context)
+            value
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/hq/graphql/version.rb

@@ -1,5 +1,5 @@
 module HQ
   module GraphQL
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/hq/graphql.rb

@@ -35,7 +35,6 @@ end
 
 require "hq/graphql/active_record_extensions"
 require "hq/graphql/scalars"
-require "hq/graphql/input_extensions"
 
 require "hq/graphql/inputs"
 require "hq/graphql/input_object"

data/spec/lib/graphql/{mutation_spec.rb → input_object_spec.rb}

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe ::HQ::GraphQL::Mutation do
+describe ::HQ::GraphQL::InputObject do
 
   describe ".with_model" do
     let(:hq_input_object) do
@@ -27,7 +27,7 @@ describe ::HQ::GraphQL::Mutation do
       end
 
       expect(hq_input_object.arguments.keys).to be_empty
-      hq_input_object.payload_type
+      hq_input_object.graphql_definition
       expected = ["createdAt", "id", "name", "organizationId", "updatedAt"]
       expect(hq_input_object.arguments.keys).to contain_exactly(*expected)
     end
@@ -40,7 +40,7 @@ describe ::HQ::GraphQL::Mutation do
         end
 
         expect(hq_input_object.arguments.keys).to be_empty
-        hq_input_object.payload_type
+        hq_input_object.graphql_definition
         expected = ["name", "updatedAt"]
         expect(hq_input_object.arguments.keys).to contain_exactly(*expected)
       end
@@ -51,7 +51,7 @@ describe ::HQ::GraphQL::Mutation do
           with_model "Advisor"
         end
 
-        expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+        expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
       end
 
       it "raises an error when not connected to a model" do
@@ -59,7 +59,7 @@ describe ::HQ::GraphQL::Mutation do
           remove_attributes :created_at
         end
 
-        expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+        expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
       end
     end
 
@@ -71,7 +71,7 @@ describe ::HQ::GraphQL::Mutation do
         end
 
         expect(hq_input_object.arguments.keys).to be_empty
-        hq_input_object.payload_type
+        hq_input_object.graphql_definition
         expected = ["createdAt", "id", "name", "organizationId", "updatedAt"]
         expect(hq_input_object.arguments.keys).to contain_exactly(*expected)
       end
@@ -82,7 +82,7 @@ describe ::HQ::GraphQL::Mutation do
           with_model "Advisor"
         end
 
-        expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+        expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
       end
 
       it "raises an error when not connected to a model" do
@@ -90,13 +90,13 @@ describe ::HQ::GraphQL::Mutation do
           remove_associations :organization
         end
 
-        expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+        expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
       end
     end
 
     context "with attributes and associations turned off" do
       it "doesn't have any arguments by default" do
-        hq_input_object.payload_type
+        hq_input_object.graphql_definition
         expect(hq_input_object.arguments.keys).to be_empty
       end
 
@@ -104,7 +104,7 @@ describe ::HQ::GraphQL::Mutation do
         hq_input_object.class_eval do
           with_model "Advisor", attributes: false, associations: false
         end
-        hq_input_object.payload_type
+        hq_input_object.graphql_definition
         expect(hq_input_object.arguments.keys).to be_empty
       end
 
@@ -116,7 +116,7 @@ describe ::HQ::GraphQL::Mutation do
           end
 
           expect(hq_input_object.arguments.keys).to be_empty
-          hq_input_object.payload_type
+          hq_input_object.graphql_definition
           expect(hq_input_object.arguments.keys).to contain_exactly("name")
         end
 
@@ -126,7 +126,7 @@ describe ::HQ::GraphQL::Mutation do
             with_model "Advisor", attributes: false, associations: false
           end
 
-          expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+          expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
         end
 
         it "raises an error when not connected to a model" do
@@ -134,7 +134,7 @@ describe ::HQ::GraphQL::Mutation do
             add_attributes :name
           end
 
-          expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+          expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
         end
       end
 
@@ -146,8 +146,8 @@ describe ::HQ::GraphQL::Mutation do
           end
 
           expect(hq_input_object.arguments.keys).to be_empty
-          hq_input_object.payload_type
-          expect(hq_input_object.arguments.keys).to contain_exactly("organizationAttributes")
+          hq_input_object.graphql_definition
+          expect(hq_input_object.arguments.keys).to contain_exactly("organization")
         end
 
         it "raises an error when adding an association that doesn't exist" do
@@ -156,7 +156,7 @@ describe ::HQ::GraphQL::Mutation do
             with_model "Advisor", attributes: false, associations: false
           end
 
-          expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+          expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
         end
 
         it "raises an error when not connected to a model" do
@@ -164,7 +164,7 @@ describe ::HQ::GraphQL::Mutation do
             add_associations :organization
           end
 
-          expect { hq_input_object.payload_type }.to raise_error(described_class::Error)
+          expect { hq_input_object.graphql_definition }.to raise_error(described_class::Error)
         end
       end
     end

data/spec/lib/graphql/resource_spec.rb

@@ -179,8 +179,14 @@ describe ::HQ::GraphQL::Resource do
       update_mutation = advisor_type.mutation_klasses[:update_advisor]
       update_mutation.payload_type
 
+      input_object = advisor_type.input_klass
+      input_object.graphql_definition
+
       aggregate_failures do
-        expected_arguments = ["id", "organizationId", "organizationAttributes", "createdAt", "updatedAt"]
+        expected_arguments = ["id", "organizationId", "organization", "createdAt", "updatedAt"]
+        expect(input_object.arguments.keys).to contain_exactly(*expected_arguments)
+
+        expected_arguments = ["id", "attributes"]
         expect(update_mutation.arguments.keys).to contain_exactly(*expected_arguments)
 
         expected_fields = ["errors", "resource"]
@@ -207,8 +213,8 @@ describe ::HQ::GraphQL::Resource do
 
     let(:create_mutation) {
       <<-gql
-        mutation createAdvisor($name: String!, $organizationId: UUID!){
-          createAdvisor(name: $name, organizationId: $organizationId) {
+        mutation createAdvisor($attributes: AdvisorInput!){
+          createAdvisor(attributes: $attributes) {
             errors
             resource {
               id
@@ -221,8 +227,8 @@ describe ::HQ::GraphQL::Resource do
 
     let(:update_mutation) {
       <<-gql
-        mutation updateAdvisor($id: UUID!, $name: String!, $organizationAttributes: OrganizationInput){
-          updateAdvisor(id: $id, name: $name, organizationAttributes: $organizationAttributes) {
+        mutation updateAdvisor($id: UUID!, $attributes: AdvisorInput!){
+          updateAdvisor(id: $id, attributes: $attributes) {
             errors
             resource {
               name
@@ -275,7 +281,7 @@ describe ::HQ::GraphQL::Resource do
     it "creates" do
       organization = FactoryBot.create(:organization)
       name = "Bob"
-      results = schema.execute(create_mutation, variables: { name: name, organizationId: organization.id })
+      results = schema.execute(create_mutation, variables: { attributes: { name: name, organizationId: organization.id } })
 
       data = results["data"]
       aggregate_failures do
@@ -292,8 +298,10 @@ describe ::HQ::GraphQL::Resource do
 
       results = schema.execute(update_mutation, variables: {
         id: advisor.id,
-        name: name,
-        organizationAttributes: { id: advisor.organization_id, name: organization_name }
+        attributes: {
+          name: name,
+          organization: { id: advisor.organization_id, name: organization_name }
+        }
       })
 
       data = results["data"]
@@ -332,7 +340,12 @@ describe ::HQ::GraphQL::Resource do
 
       it "returns an error on a mutation" do
         advisor = FactoryBot.create(:advisor)
-        results = schema.execute(update_mutation, variables: { id: advisor.id, name: "Bob" })
+        results = schema.execute(update_mutation, variables: {
+          id: advisor.id,
+          attributes: {
+            name: "Bob"
+          }
+        })
 
         data = results["data"]
         aggregate_failures do
@@ -360,7 +373,12 @@ describe ::HQ::GraphQL::Resource do
 
       it "returns an error on a mutation" do
         advisor = FactoryBot.create(:advisor)
-        results = schema.execute(update_mutation, variables: { id: advisor.id, name: "Bob" })
+        results = schema.execute(update_mutation, variables: {
+          id: advisor.id,
+          attributes: {
+            name: "Bob"
+          }
+        })
 
         data = results["data"]
         aggregate_failures do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hq-graphql
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Danny Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -98,7 +98,6 @@ files:
 - 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
@@ -109,6 +108,7 @@ files:
 - lib/hq/graphql/root_query.rb
 - lib/hq/graphql/scalars.rb
 - lib/hq/graphql/types.rb
+- lib/hq/graphql/types/json.rb
 - lib/hq/graphql/types/uuid.rb
 - lib/hq/graphql/version.rb
 - spec/factories/advisors.rb
@@ -121,8 +121,8 @@ files:
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
 - spec/lib/graphql/active_record_extensions_spec.rb
+- spec/lib/graphql/input_object_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
@@ -169,6 +169,6 @@ test_files:
 - spec/lib/graphql/object_spec.rb
 - spec/lib/graphql/inputs_spec.rb
 - spec/lib/graphql/resource_spec.rb
+- spec/lib/graphql/input_object_spec.rb
 - spec/lib/graphql/types_spec.rb
-- spec/lib/graphql/mutation_spec.rb
 - spec/rails_helper.rb

data/lib/hq/graphql/input_extensions.rb

@@ -1,56 +0,0 @@
-module HQ
-  module GraphQL
-    module InputExtensions
-
-      def self.included(base)
-        base.include Scalars
-        base.include ::HQ::GraphQL::ActiveRecordExtensions
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-
-        def with_model(model_name, attributes: true, associations: false)
-          self.model_name = model_name
-          self.auto_load_attributes = attributes
-          self.auto_load_associations = associations
-
-          lazy_load do
-            model_columns.each do |column|
-              argument_from_column(column)
-            end
-
-            model_associations.each do |association|
-              argument_from_association association
-            end
-          end
-        end
-
-        private
-
-        def argument_from_association(association)
-          input = ::HQ::GraphQL::Inputs[association.klass]
-          name = association.name
-          name_attributes = "#{name}_attributes"
-          case association.macro
-          when :has_many
-            argument name_attributes, [input], required: false
-          else
-            argument name_attributes, input, required: false
-          end
-
-          if !model_klass.nested_attributes_options.keys.include?(name.to_sym)
-            model_klass.accepts_nested_attributes_for name, allow_destroy: true
-          end
-        rescue ::HQ::GraphQL::Inputs::Error
-          nil
-        end
-
-        def argument_from_column(column)
-          argument column.name, ::HQ::GraphQL::Types.type_from_column(column), required: false
-        end
-
-      end
-    end
-  end
-end