hq-graphql 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 13d8a60ff262b288fd5918633fc2db7450620e2b
-  data.tar.gz: 611a0ae3cea59bc3318339dc4d06d9c6370ccbde
+SHA256:
+  metadata.gz: 7efcc65afc49394548596015925cb1507dbcc34a5a7517256b430bef6528e9a0
+  data.tar.gz: 73412d83d3ed91883e2429b1d6ace253fc7df899358d4a22ff5f70afebdf9a31
 SHA512:
-  metadata.gz: 4ac1a7aee6c9eb6df449258dfc71624900fee0e70d6c50f8d57596acf6a9b76ce7a81da4ab26aaa7d6b1bd3bc104402c5deff3630821a193a74a040f45ef2757
-  data.tar.gz: f78cee42cdece49c7211ceec67ac576438eb9bc4e707d9dbb9d6deab6f0835f88ee954cf25f8d8b7b875e29b9126b1aa0adbad8c30b78c702c2ef6d7234e0b8b
+  metadata.gz: d91c6236223a1e7d87c4a2fc46bcc3648d291db13d376d7afef25c0441007f4e651072081fcba1ec8edea259b689930d106473d03a91908ab9a4ebf62348c99e
+  data.tar.gz: 425964b4dfd40e6f30b34a061c8486ce1bcef8d3860ece699790aac1064943a36a203dfc373a66d5f8372eedc4cff5298fe01611eb0a1ada0bf67614c9238a3e

data/README.md

@@ -89,7 +89,7 @@ class Schema < ::GraphQL::Schema
 end
 ```
 
-### Root Queries
+### Default Root Queries
 Create a root query:
 ```ruby
 class AdvisorResource
@@ -106,6 +106,26 @@ class Schema < ::GraphQL::Schema
 end
 ```
 
+### Custom Root Queries
+```ruby
+class AdvisorResource
+  include ::HQ::GraphQL::Resource
+  self.model_name = "Advisor"
+
+  def_root :advisors, is_array: true, null: false do
+    argument :active, ::GraphQL::Types::Boolean, required: false
+
+    def resolve(active: nil)
+      scope = Advisor.all
+
+      if active
+        scope = scope.where(active: true)
+      end
+    end
+  end
+end
+```
+
 ## Create a new ::HQ::GraphQL::Object
 ```ruby
 class AdvisorType < ::HQ::GraphQL::Object

data/lib/hq/graphql/input_object.rb

@@ -8,7 +8,16 @@ module HQ
       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
+            formatted_value =
+              if value.is_a?(Array)
+                value.map(&:format_nested_attributes)
+              elsif value
+                value.format_nested_attributes
+              end
+
+            formatted_attrs[:"#{key}_attributes"] = formatted_value if formatted_value
+          elsif key.to_s == "x"
+            formatted_attrs[:X] = value
           else
             formatted_attrs[key] = value
           end
@@ -35,6 +44,8 @@ module HQ
           model_associations.each do |association|
             argument_from_association association
           end
+
+          argument :X, String, required: false
         end
       end
 

data/lib/hq/graphql/resource.rb

@@ -11,7 +11,7 @@ module HQ
       end
 
       module ClassMethods
-        attr_accessor :model_name
+        attr_writer :graphql_name, :model_name
 
         def find_record(attrs, context)
           primary_key = model_klass.primary_key.to_sym
@@ -19,6 +19,14 @@ module HQ
           scope(context).find_by(primary_key => primary_key_value)
         end
 
+        def graphql_name
+          @graphql_name || model_name.demodulize
+        end
+
+        def model_name
+          @model_name || name.demodulize
+        end
+
         def model_klass
           @model_klass ||= model_name&.safe_constantize
         end
@@ -46,12 +54,12 @@ module HQ
         end
 
         def mutations(create: true, update: true, destroy: true)
+          scoped_graphql_name = graphql_name
           scoped_model_name = model_name
-          model_display_name = model_name.demodulize
           scoped_self = self
 
           if create
-            create_mutation = ::HQ::GraphQL::Resource::Mutation.build(model_name, graphql_name: "#{model_display_name}Create") do
+            create_mutation = ::HQ::GraphQL::Resource::Mutation.build(model_name, graphql_name: "#{scoped_graphql_name}Create") do
               define_method(:resolve) do |**args|
                 resource = scoped_self.model_klass.new
                 resource.assign_attributes(args[:attributes].format_nested_attributes)
@@ -73,13 +81,13 @@ module HQ
               end
             end
 
-            mutation_klasses["create_#{model_display_name.underscore}"] = create_mutation
+            mutation_klasses["create_#{scoped_graphql_name.underscore}"] = create_mutation
           end
 
           if update
             update_mutation = ::HQ::GraphQL::Resource::Mutation.build(
               model_name,
-              graphql_name: "#{model_display_name}Update",
+              graphql_name: "#{scoped_graphql_name}Update",
               require_primary_key: true
             ) do
               define_method(:resolve) do |**args|
@@ -94,14 +102,14 @@ module HQ
                     }
                   else
                     {
-                      resource: resource,
+                      resource: nil,
                       errors: errors_from_resource(resource)
                     }
                   end
                 else
                   {
                     resource: nil,
-                    errors: { resource: "Unable to find #{model_display_name}" }
+                    errors: { resource: "Unable to find #{scoped_graphql_name}" }
                   }
                 end
               end
@@ -111,13 +119,13 @@ module HQ
               end
             end
 
-            mutation_klasses["update_#{model_display_name.underscore}"] = update_mutation
+            mutation_klasses["update_#{scoped_graphql_name.underscore}"] = update_mutation
           end
 
           if destroy
             destroy_mutation = ::HQ::GraphQL::Resource::Mutation.build(
               model_name,
-              graphql_name: "#{model_display_name}Destroy",
+              graphql_name: "#{scoped_graphql_name}Destroy",
               require_primary_key: true
             ) do
               define_method(:resolve) do |**attrs|
@@ -131,20 +139,20 @@ module HQ
                     }
                   else
                     {
-                      resource: resource,
+                      resource: nil,
                       errors: errors_from_resource(resource)
                     }
                   end
                 else
                   {
                     resource: nil,
-                    errors: { resource: "Unable to find #{model_display_name}" }
+                    errors: { resource: "Unable to find #{scoped_graphql_name}" }
                   }
                 end
               end
             end
 
-            mutation_klasses["destroy_#{model_display_name.underscore}"] = destroy_mutation
+            mutation_klasses["destroy_#{scoped_graphql_name.underscore}"] = destroy_mutation
           end
         end
 
@@ -152,8 +160,45 @@ module HQ
           @query_klass = build_graphql_object(**options, &block)
         end
 
-        def root_query
-          ::HQ::GraphQL.root_queries << self
+        def def_root(field_name, is_array: false, null: true, &block)
+          graphql = self
+          resolver = -> {
+            Class.new(::GraphQL::Schema::Resolver) do
+              type = is_array ? [graphql.query_klass] : graphql.query_klass
+              type type, null: null
+              class_eval(&block) if block
+            end
+          }
+          ::HQ::GraphQL.root_queries << {
+            field_name: field_name, resolver: resolver
+          }
+        end
+
+        def root_query(find_one: true, find_all: true)
+          field_name = graphql_name.underscore
+          scoped_self = self
+
+          if find_one
+            def_root field_name, is_array: false, null: true do
+              klass = scoped_self.model_klass
+              primary_key = klass.primary_key
+              pk_column = klass.columns.detect { |c| c.name == primary_key.to_s }
+
+              argument primary_key, ::HQ::GraphQL::Types.type_from_column(pk_column), required: true
+
+              define_method(:resolve) do |**attrs|
+                scoped_self.find_record(attrs, context)
+              end
+            end
+          end
+
+          if find_all
+            def_root field_name.pluralize, is_array: true, null: false do
+              define_method(:resolve) do |**attrs|
+                scoped_self.scope(context).all
+              end
+            end
+          end
         end
 
         def scope(context)
@@ -165,9 +210,10 @@ module HQ
         private
 
         def build_graphql_object(**options, &block)
+          scoped_graphql_name = graphql_name
           scoped_model_name = model_name
           Class.new(::HQ::GraphQL::Object) do
-            graphql_name scoped_model_name
+            graphql_name scoped_graphql_name
 
             with_model scoped_model_name, **options
 
@@ -176,9 +222,10 @@ module HQ
         end
 
         def build_input_object(**options, &block)
+          scoped_graphql_name = graphql_name
           scoped_model_name = model_name
           Class.new(::HQ::GraphQL::InputObject) do
-            graphql_name "#{scoped_model_name.demodulize}Input"
+            graphql_name "#{scoped_graphql_name}Input"
 
             with_model scoped_model_name, **options
 

data/lib/hq/graphql/root_query.rb

@@ -6,19 +6,8 @@ module HQ
         super
         base.class_eval do
           lazy_load do
-            ::HQ::GraphQL.root_queries.each do |graphql|
-              klass = graphql.model_klass
-              field_name = klass.name.demodulize.underscore
-              primary_key = klass.primary_key
-              pk_column = klass.columns.detect { |c| c.name == primary_key.to_s }
-
-              field field_name, graphql.query_klass, null: true do
-                argument primary_key, ::HQ::GraphQL::Types.type_from_column(pk_column), required: true
-              end
-
-              define_method(field_name) do |**attrs|
-                graphql.find_record(attrs, context)
-              end
+            ::HQ::GraphQL.root_queries.each do |field_name:, resolver:|
+              field field_name, resolver: resolver.call
             end
           end
         end

data/lib/hq/graphql/types.rb

@@ -40,6 +40,7 @@ module HQ
         def klass_for(klass_or_string)
           klass = klass_or_string.is_a?(String) ? klass_or_string.constantize : klass_or_string
           ::HQ::GraphQL.types.detect { |t| t.model_klass == klass }&.query_klass ||
+          ::HQ::GraphQL.types.detect { |t| t.model_klass == klass.base_class }&.query_klass ||
              raise(Error, Error::MISSING_TYPE_MSG % { klass: klass.name })
         end
       end

data/lib/hq/graphql/version.rb

@@ -1,5 +1,5 @@
 module HQ
   module GraphQL
-    VERSION = "1.1.1"
+    VERSION = "1.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hq-graphql
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Danny Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-27 00:00:00.000000000 Z
+date: 2019-07-02 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.10
+        version: 1.9.6
   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.10
+        version: 1.9.6
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -111,26 +111,6 @@ files:
 - lib/hq/graphql/types/object.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/models/advisor.rb
-- spec/internal/app/models/organization.rb
-- spec/internal/app/models/test_type.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/graphql/active_record_extensions_spec.rb
-- spec/lib/graphql/input_object_spec.rb
-- spec/lib/graphql/inputs_spec.rb
-- spec/lib/graphql/object_spec.rb
-- spec/lib/graphql/resource_spec.rb
-- spec/lib/graphql/types/object_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
 licenses:
 - MIT
@@ -151,28 +131,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: OneHQ GraphQL Library
-test_files:
-- spec/spec_helper.rb
-- spec/internal/app/models/advisor.rb
-- spec/internal/app/models/organization.rb
-- spec/internal/app/models/test_type.rb
-- spec/internal/app/models/user.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/graphql/types/object_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/input_object_spec.rb
-- spec/lib/graphql/types_spec.rb
-- spec/rails_helper.rb
+test_files: []

data/spec/factories/advisors.rb

@@ -1,6 +0,0 @@
-FactoryBot.define do
-  factory :advisor do
-    name                    { Faker::Name.name }
-    organization            { FactoryBot.build(:organization) }
-  end
-end

data/spec/factories/organizations.rb

@@ -1,5 +0,0 @@
-FactoryBot.define do
-  factory :organization do
-    name                         { Faker::Company.name }
-  end
-end

data/spec/factories/users.rb

@@ -1,6 +0,0 @@
-FactoryBot.define do
-  factory :user do
-    name                { Faker::Name.name }
-    organization        { FactoryBot.build(:organization) }
-  end
-end

data/spec/internal/app/models/advisor.rb

@@ -1,3 +0,0 @@
-class Advisor < ActiveRecord::Base
-  belongs_to :organization
-end

data/spec/internal/app/models/organization.rb

@@ -1,3 +0,0 @@
-class Organization < ::ActiveRecord::Base
-  has_many :users, inverse_of: :organization
-end

data/spec/internal/app/models/test_type.rb

@@ -1 +0,0 @@
-class TestType < ::ActiveRecord::Base; end

data/spec/internal/app/models/user.rb

@@ -1,3 +0,0 @@
-class User < ::ActiveRecord::Base
-  belongs_to :organization, inverse_of: :users
-end

data/spec/internal/config/database.circleci.yml

@@ -1,24 +0,0 @@
-common: &common
-  adapter: postgresql
-  encoding: utf8
-  host: <%= ENV["DBHOST"] || "127.0.0.1" %>
-  port: <%= ENV["DBPORT"] || "5432" %>
-  database: <%= ENV["DBNAME"] || "hq-graphql" %>
-  username: <%= ENV["DBUSER"] || "postgres" %>
-  password: <%= ENV["DBPASSWORD"] || "" %>
-  pool: 5
-  reconnect: true
-  timeout: 5000
-
-development:
-  <<: *common
-
-test:
-  <<: *common
-
-staging:
-  <<: *common
-
-production:
-  <<: *common
-  pool: 10

data/spec/internal/config/database.yml

@@ -1,8 +0,0 @@
-test:
-  adapter: postgresql
-  database: <%= ENV['DB'] || 'hq-graphql_test' %>
-  username: <%= ENV['DB_USERNAME'] || %x[id -un] %> # `id -un` returns the active user in OSX (at least as of 10.10)
-  password:
-  timeout: 5000
-  encoding: utf8
-  pool: 25

data/spec/internal/db/schema.rb

@@ -1,30 +0,0 @@
-ActiveRecord::Schema.define do
-  enable_extension "uuid-ossp"
-
-  create_table "organizations", force: true, id: :uuid do |t|
-    t.string   :name,                  limit: 63, null: false
-    t.timestamps                       null: false
-  end
-
-  create_table "users", force: true, id: :uuid do |t|
-    t.belongs_to  :organization,       null: false, index: true, foreign_key: true, type: :uuid
-    t.string      :name,               null: false
-    t.timestamps                       null: false
-  end
-
-  create_table "advisors", force: true, id: :uuid do |t|
-    t.references  :organization,       null: false, index: true, foreign_key: true, type: :uuid
-    t.string      :name,               null: false
-    t.timestamps                       null: false
-  end
-
-  create_table "test_types", force: true, id: :uuid do |t|
-    t.jsonb       :data_jsonb
-    t.json        :data_json
-    t.integer     :count
-    t.decimal     :amount
-    t.boolean     :is_bool
-    t.string      :name
-  end
-
-end

data/spec/lib/graphql/active_record_extensions_spec.rb

@@ -1,63 +0,0 @@
-require 'rails_helper'
-
-describe ::HQ::GraphQL::ActiveRecordExtensions do
-  let(:extended_klass) do
-    Class.new do
-      include ::HQ::GraphQL::ActiveRecordExtensions
-
-      @counter = 0
-
-      lazy_load do
-        @counter += 1
-      end
-
-      def self.counter
-        @counter
-      end
-    end
-  end
-
-  describe ".add_attributes" do
-    it "aliases add_attributes" do
-      add_attributes = extended_klass.method(:add_attributes)
-      aggregate_failures do
-        expect(add_attributes).to eql(extended_klass.method(:add_attribute))
-        expect(add_attributes).to eql(extended_klass.method(:add_attrs))
-        expect(add_attributes).to eql(extended_klass.method(:add_attr))
-      end
-    end
-  end
-
-  describe ".remove_attributes" do
-    it "aliases remove_attributes" do
-      remove_attributes = extended_klass.method(:remove_attributes)
-      aggregate_failures do
-        expect(remove_attributes).to eql(extended_klass.method(:remove_attribute))
-        expect(remove_attributes).to eql(extended_klass.method(:remove_attrs))
-        expect(remove_attributes).to eql(extended_klass.method(:remove_attr))
-      end
-    end
-  end
-
-  describe ".add_associations" do
-    it "aliases add_associations" do
-      expect(extended_klass.method(:add_associations)).to eql(extended_klass.method(:add_association))
-    end
-  end
-
-  describe ".remove_associations" do
-    it "aliases remove_associations" do
-      expect(extended_klass.method(:remove_associations)).to eql(extended_klass.method(:remove_association))
-    end
-  end
-
-  describe ".lazy_load" do
-    it "lazy loads once" do
-      # First time it works
-      expect { extended_klass.lazy_load! }.to change  { extended_klass.counter }.by(1)
-      # Second time it does nothing
-      expect { extended_klass.lazy_load! }.to change  { extended_klass.counter }.by(0)
-    end
-  end
-
-end