graphql-sugar 0.1.1

data/lib/generators/graphql/resolver/resolver_generator.rb

@@ -0,0 +1,9 @@
+module Graphql
+  class ResolverGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_resolver
+      template 'resolver.erb', File.join('app/graphql/resolvers', class_path, "#{file_name}_resolver.rb")
+    end
+  end
+end

data/lib/generators/graphql/resolver/templates/resolver.erb

@@ -0,0 +1,4 @@
+class <%= class_name %>Resolver < ApplicationResolver
+  def resolve
+  end
+end

data/lib/generators/graphql/sugar/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Installs GraphQL::Sugar
+
+Example:
+    rails generate graphql:sugar
+
+    This will create:
+        app/graphql/functions/application_function.rb
+        app/graphql/resolvers/application_resolver.rb
+        app/graphql/mutators/application_mutator.rb

data/lib/generators/graphql/sugar/sugar_generator.rb

@@ -0,0 +1,17 @@
+module Graphql
+  class SugarGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def add_paths
+      application { 'config.eager_load_paths += Dir["#{config.root}/app/graphql/functions/**/"]' }
+      application { 'config.eager_load_paths += Dir["#{config.root}/app/graphql/mutators/**/"]' }
+      application { 'config.eager_load_paths += Dir["#{config.root}/app/graphql/resolvers/**/"]' }
+    end
+
+    def create_application_files
+      template 'application_function.erb', 'app/graphql/functions/application_function.rb'
+      template 'application_resolver.erb', 'app/graphql/resolvers/application_resolver.rb'
+      template 'application_mutator.erb', 'app/graphql/mutators/application_mutator.rb'
+    end
+  end
+end

data/lib/generators/graphql/sugar/templates/application_function.erb

@@ -0,0 +1,3 @@
+class ApplicationFunction < GraphQL::Function
+  include GraphQL::Sugar::Function
+end

data/lib/generators/graphql/sugar/templates/application_mutator.erb

@@ -0,0 +1,3 @@
+class ApplicationMutator < ApplicationFunction
+  include GraphQL::Sugar::Mutator
+end

data/lib/generators/graphql/sugar/templates/application_resolver.erb

@@ -0,0 +1,3 @@
+class ApplicationResolver < ApplicationFunction
+  include GraphQL::Sugar::Resolver
+end

data/lib/graphql/sugar/boot.rb

@@ -0,0 +1,18 @@
+GraphQL::ObjectType.accepts_definitions(
+  resolver: GraphQL::Sugar::Define::Resolver,
+  mutator: GraphQL::Sugar::Define::Mutator,
+  model_class: GraphQL::Sugar::Define::ModelClass,
+  attribute: GraphQL::Sugar::Define::Attribute,
+  attributes: GraphQL::Sugar::Define::Attributes,
+  relationship: GraphQL::Sugar::Define::Relationship,
+  relationships: GraphQL::Sugar::Define::Relationships
+)
+
+GraphQL::Field.accepts_definitions(
+  parameter: GraphQL::Sugar::Define::Parameter
+)
+
+GraphQL::InputObjectType.accepts_definitions(
+  model_class: GraphQL::Define.assign_metadata_key(:model_class),
+  parameter: GraphQL::Sugar::Define::Parameter
+)

data/lib/graphql/sugar/define/attribute.rb

@@ -0,0 +1,19 @@
+module GraphQL
+  module Sugar
+    module Define
+      module Attribute
+        def self.call(type_defn, field_name, type_or_field = nil, desc = nil, **kwargs, &block) # rubocop:disable Metrics/ParameterLists
+          model_class = Sugar.get_model_class(type_defn)
+          column_name = Sugar.get_column_name(field_name)
+
+          type_or_field ||= kwargs[:type] if !kwargs[:type].nil?
+          type_or_field ||= Sugar.get_graphql_type(model_class, column_name)
+
+          kwargs[:property] ||= column_name.to_sym if kwargs[:resolve].nil?
+
+          GraphQL::Define::AssignObjectField.call(type_defn, field_name, type_or_field, desc, **kwargs, &block)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/define/attributes.rb

@@ -0,0 +1,16 @@
+module GraphQL
+  module Sugar
+    module Define
+      module Attributes
+        def self.call(type_defn, *field_names)
+          model_class = Sugar.get_model_class(type_defn)
+
+          field_names = model_class.columns_hash.keys.map(&:to_sym) if field_names.count == 0
+          field_names.each do |field_name|
+            Sugar::Define::Attribute.call(type_defn, field_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/define/model_class.rb

@@ -0,0 +1,21 @@
+module GraphQL
+  module Sugar
+    module Define
+      module ModelClass
+        def self.call(type_defn, model_class, type_name = nil)
+          type_defn.name = type_name || model_class.to_s
+          type_defn.metadata[:model_class] = model_class
+
+          common_field_names = [:id, :createdAt, :updatedAt]
+          common_field_names.each do |common_field_name|
+            begin
+              Sugar::Define::Attribute.call(type_defn, common_field_name)
+            rescue => e
+              Rails.logger.warn e
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/define/mutator.rb

@@ -0,0 +1,16 @@
+module GraphQL
+  module Sugar
+    module Define
+      module Mutator
+        def self.call(type_defn, field_name, type_or_field = nil, desc = nil, **kwargs, &block) # rubocop:disable Metrics/ParameterLists
+          # Automatically determine function
+          function_class = Sugar.get_mutator_function(field_name)
+          kwargs[:function] ||= function_class.new
+          kwargs[:resolve] ||= ->(obj, args, ctx) { function_class.new.call(obj, args, ctx) }
+
+          GraphQL::Define::AssignObjectField.call(type_defn, field_name, type_or_field, desc, **kwargs, &block)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/define/parameter.rb

@@ -0,0 +1,26 @@
+module GraphQL
+  module Sugar
+    module Define
+      module Parameter
+        def self.call(type_defn, name, type = nil, *args, **kwargs, &block) # rubocop:disable Metrics/ParameterLists
+          model_class = type_defn.metadata[:model_class]
+
+          type ||= kwargs[:type]
+
+          if type.nil?
+            column_name = Sugar.get_column_name(name)
+            type = Sugar.get_graphql_type(model_class, column_name, enforce_non_null: false)
+          end
+
+          if kwargs[:as].nil?
+            field_name = name.to_s.underscore.to_sym
+            field_name = "#{field_name}_attributes".to_sym if model_class && model_class.nested_attributes_options[field_name]
+            kwargs[:as] = field_name
+          end
+
+          GraphQL::Define::AssignArgument.call(type_defn, name, type, *args, **kwargs, &block)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/define/relationship.rb

@@ -0,0 +1,57 @@
+module GraphQL
+  module Sugar
+    module Define
+      module Relationship
+        def self.call(type_defn, field_name)
+          model_class = Sugar.get_model_class(type_defn)
+          association_name = Sugar.get_association_name(field_name)
+          association = model_class.reflect_on_association(association_name)
+
+          if association.association_class == ActiveRecord::Associations::BelongsToAssociation
+            define_belongs_to(type_defn, field_name, model_class, association_name, association)
+          elsif association.association_class == ActiveRecord::Associations::HasOneAssociation ||
+                association.association_class == ActiveRecord::Associations::HasManyAssociation
+            define_has_many(type_defn, field_name, model_class, association_name, association)
+          end
+        end
+
+        def self.define_belongs_to(type_defn, field_name, model_class, association_name, association)
+          key_field_name = association.foreign_key.to_s.camelize(:lower).to_sym
+          key_type = GraphQL::ID_TYPE
+          key_property = association.foreign_key.to_sym
+
+          type = "Types::#{association.klass}Type".constantize
+          property = association_name.to_sym
+
+          key_column_details = Sugar.get_column_details(model_class, association.foreign_key)
+          is_not_null = !key_column_details.null || Sugar.validates_presence?(model_class, association_name)
+
+          if is_not_null
+            key_type = key_type.to_non_null_type
+            type = type.to_non_null_type
+          end
+
+          GraphQL::Define::AssignObjectField.call(type_defn, key_field_name, type: key_type, property: key_property)
+          GraphQL::Define::AssignObjectField.call(type_defn, field_name, type: type, property: property)
+        end
+
+        def self.define_has_many(type_defn, field_name, _model_class, association_name, association)
+          kwargs = {}
+
+          kwargs[:type] = "Types::#{association.klass}Type".constantize
+          kwargs[:type] = kwargs[:type].to_non_null_type.to_list_type
+
+          begin
+            function_class = Sugar.get_resolver_function(field_name)
+            kwargs[:function] ||= function_class.new
+            kwargs[:resolve] ||= ->(obj, args, ctx) { function_class.new.call(obj, args, ctx) }
+          rescue
+            kwargs[:property] = association_name.to_sym
+          end
+
+          GraphQL::Define::AssignObjectField.call(type_defn, field_name, **kwargs)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/define/relationships.rb

@@ -0,0 +1,23 @@
+module GraphQL
+  module Sugar
+    module Define
+      module Relationships
+        def self.call(type_defn, *field_names)
+          model_class = Sugar.get_model_class(type_defn)
+
+          if field_names.count == 0
+            [:belongs_to, :has_one, :has_many].each do |macro|
+              model_class.reflect_on_all_associations(macro).each do |association|
+                field_names << association.name
+              end
+            end
+          end
+
+          field_names.each do |field_name|
+            Sugar::Define::Relationship.call(type_defn, field_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/define/resolver.rb

@@ -0,0 +1,25 @@
+module GraphQL
+  module Sugar
+    module Define
+      module Resolver
+        def self.call(type_defn, field_name, type_or_field = nil, desc = nil, **kwargs, &block) # rubocop:disable Metrics/ParameterLists
+          # Automatically determine type
+          type_or_field ||= kwargs[:type] if !kwargs[:type].nil?
+          type_or_field ||= Sugar.get_resolver_graphql_type(field_name)
+
+          # Automatically determine if plural, modify type to !types[Type] if true
+          plural = kwargs[:plural]
+          plural = Sugar.get_resolver_plural(field_name) if plural.nil?
+          type_or_field = type_or_field.to_list_type.to_non_null_type if plural
+
+          # Automatically determine function
+          function_class = Sugar.get_resolver_function(field_name)
+          kwargs[:function] ||= function_class.new
+          kwargs[:resolve] ||= ->(obj, args, ctx) { function_class.new.call(obj, args, ctx) }
+
+          GraphQL::Define::AssignObjectField.call(type_defn, field_name, type_or_field, desc, **kwargs, &block)
+        end
+      end
+    end
+  end
+end

data/lib/graphql/sugar/function.rb

@@ -0,0 +1,31 @@
+module GraphQL
+  module Sugar
+    module Function
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          attr_reader :object
+          attr_reader :params
+          attr_reader :context
+        end
+      end
+
+      module ClassMethods
+        # Workaround:
+        # A `GraphQL::Function` is supposed to be a 'reusable container for field logic'.
+        # However, extended Field DSL (specified using `GraphQL::Field.accepts_definitions(...)`)
+        # is not available within Functions. Therefore, re-defining it here.
+        def parameter(name, *args, **kwargs, &block)
+          kwargs[:as] ||= name.to_s.underscore.to_sym
+          argument(name, *args, **kwargs, &block)
+        end
+      end
+
+      def call(obj, args, ctx)
+        @object = obj
+        @params = args.to_h.deep_symbolize_keys
+        @context = ctx
+      end
+    end
+  end
+end

data/lib/graphql/sugar/mutator.rb

@@ -0,0 +1,11 @@
+module GraphQL
+  module Sugar
+    module Mutator
+      def call(obj, args, ctx)
+        super
+
+        mutate
+      end
+    end
+  end
+end

data/lib/graphql/sugar/resolver.rb

@@ -0,0 +1,11 @@
+module GraphQL
+  module Sugar
+    module Resolver
+      def call(obj, args, ctx)
+        super
+
+        resolve
+      end
+    end
+  end
+end

data/lib/graphql/sugar/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  module Sugar
+    VERSION = '0.1.1'
+  end
+end

data/lib/graphql/sugar.rb

@@ -0,0 +1,99 @@
+require 'graphql/sugar/version'
+
+module GraphQL
+  module Sugar
+    GRAPHQL_TYPE_MAPPING = {
+      integer: GraphQL::INT_TYPE,
+      float: GraphQL::FLOAT_TYPE,
+      decimal: GraphQL::FLOAT_TYPE,
+      boolean: GraphQL::BOOLEAN_TYPE,
+      string: GraphQL::STRING_TYPE
+    }.freeze
+
+    def self.get_resolver_graphql_type(field_name)
+      "Types::#{field_name.to_s.classify}Type".constantize
+    end
+
+    def self.get_resolver_function(field_name)
+      "#{field_name.to_s.camelize}Resolver".constantize
+    end
+
+    def self.get_resolver_plural(field_name)
+      field_string = field_name.to_s
+      field_string.pluralize == field_string
+    end
+
+    def self.get_mutator_function(field_name)
+      "#{field_name.to_s.camelize}Mutator".constantize
+    end
+
+    def self.get_model_class(type_defn)
+      model_class = type_defn.metadata[:model_class]
+      raise "You must define a `model_class` first in `#{type_defn.class}`." if model_class.blank?
+      model_class
+    end
+
+    def self.get_column_name(field_name)
+      field_name.to_s.underscore
+    end
+
+    def self.get_column_details(model_class, column_name)
+      column_details = model_class.columns_hash[column_name]
+      raise "The attribute '#{column_name}' doesn't exist in model '#{model_class}'." if column_details.blank?
+      column_details
+    end
+
+    def self.get_graphql_type(model_class, column_name, enforce_non_null: true) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      return GraphQL::ID_TYPE.to_non_null_type if column_name == model_class.primary_key
+
+      column_details = get_column_details(model_class, column_name)
+
+      belongs_to_association = model_class.reflect_on_all_associations(:belongs_to).find { |a| a.foreign_key == column_name }
+
+      type = if model_class.defined_enums.key?(column_name)
+               GraphQL::STRING_TYPE
+             elsif belongs_to_association.present?
+               GraphQL::ID_TYPE
+             else
+               GRAPHQL_TYPE_MAPPING[column_details.type] || GraphQL::STRING_TYPE
+             end
+
+      type = type.to_list_type if column_details.array?
+
+      if enforce_non_null
+        is_not_null = !column_details.null
+        is_not_null ||= Sugar.validates_presence?(model_class, column_name)
+        is_not_null ||= Sugar.validates_presence?(model_class, belongs_to_association.name) if belongs_to_association.present?
+        type = type.to_non_null_type if is_not_null
+      end
+
+      type
+    end
+
+    def self.get_association_name(field_name)
+      field_name.to_s.underscore
+    end
+
+    def self.validates_presence?(model_class, column_name)
+      column_validators = model_class.validators_on(column_name)
+      column_validators.any? do |validator|
+        validator.class == ActiveRecord::Validations::PresenceValidator &&
+          !validator.options.key?(:if) &&
+          !validator.options.key?(:unless)
+      end
+    end
+  end
+end
+
+require 'graphql/sugar/define/resolver'
+require 'graphql/sugar/define/mutator'
+require 'graphql/sugar/define/model_class'
+require 'graphql/sugar/define/attribute'
+require 'graphql/sugar/define/attributes'
+require 'graphql/sugar/define/relationship'
+require 'graphql/sugar/define/relationships'
+require 'graphql/sugar/define/parameter'
+require 'graphql/sugar/function'
+require 'graphql/sugar/resolver'
+require 'graphql/sugar/mutator'
+require 'graphql/sugar/boot'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: graphql-sugar
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Pradeep Kumar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- pradeep@keepworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- graphql-sugar.gemspec
+- lib/generators/graphql/mutator/USAGE
+- lib/generators/graphql/mutator/mutator_generator.rb
+- lib/generators/graphql/mutator/templates/mutator.erb
+- lib/generators/graphql/resolver/USAGE
+- lib/generators/graphql/resolver/resolver_generator.rb
+- lib/generators/graphql/resolver/templates/resolver.erb
+- lib/generators/graphql/sugar/USAGE
+- lib/generators/graphql/sugar/sugar_generator.rb
+- lib/generators/graphql/sugar/templates/application_function.erb
+- lib/generators/graphql/sugar/templates/application_mutator.erb
+- lib/generators/graphql/sugar/templates/application_resolver.erb
+- lib/graphql/sugar.rb
+- lib/graphql/sugar/boot.rb
+- lib/graphql/sugar/define/attribute.rb
+- lib/graphql/sugar/define/attributes.rb
+- lib/graphql/sugar/define/model_class.rb
+- lib/graphql/sugar/define/mutator.rb
+- lib/graphql/sugar/define/parameter.rb
+- lib/graphql/sugar/define/relationship.rb
+- lib/graphql/sugar/define/relationships.rb
+- lib/graphql/sugar/define/resolver.rb
+- lib/graphql/sugar/function.rb
+- lib/graphql/sugar/mutator.rb
+- lib/graphql/sugar/resolver.rb
+- lib/graphql/sugar/version.rb
+homepage: https://github.com/keepworks/graphql-sugar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A sweet, extended DSL written on top of the graphql-ruby gem.
+test_files: []